command_bot 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ce3490ea16754fc8c40d25e6a1c88ca15ecbb2457bb380b466c47797ad8d0af3
+  data.tar.gz: 7aff185e761c5770f853cb78053dc57b81c9ecc388ad61e93642ee98e8f2121d
+SHA512:
+  metadata.gz: b0ec894158f3d357ef9267c40549b5b8869184eda4b4beb7a30817ddd3440744108e0fa80d57a921ce493375dc050c40eed7f7e4916d808d8cdb5a77c2cc95a8
+  data.tar.gz: 831ea48cfaf594e2375a651798a1a0f775c09bbcbb6854a4a383674e87f2a0296ad75a22c190717f87bd17abfbd4210eb065da94cb839002b133ab35d80043e4

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,36 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: false
+  TargetRubyVersion: 2.6
+  Exclude:
+    - config/**/*
+    - tmp/**/*
+    - Capfile
+    - Gemfile
+    - Rakefile
+
+# Follow RubyGuides on this one
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+# Just enough
+Layout/LineLength:
+  Max: 100
+
+# Follow RubyGuides on this one
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+# Prefer using Rubies methods
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-06-12 22:08:35 +0300 using RuboCop version 0.85.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'rake', '~> 12.0'
+gem 'minitest', '~> 5.0'
+
+gem 'rubocop', '~> 0.85.0'
+gem 'rubocop-performance', require: false
+
+gem 'pry', '~> 0.13.1'
+
+gem "logger", "~> 1.4"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Fizvlad
+
+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,26 @@
+# CommandBot
+
+This gem can be used to create highly configurable text bots.
+
+## Installation
+
+Add gem to your Gemfile using
+
+	$ bundle add command_bot
+
+## Usage
+
+See `examples` folder.
+
+## Development
+
+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 tags, 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/fizvlad/command_bot.
+
+
+## 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,48 @@
+require 'bundler/gem_tasks'
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop) {}
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+namespace 'rubocop' do
+  desc 'Generate rubocop TODO file.'
+  task 'todo' do
+    puts `rubocop --auto-gen-config`
+  end
+end
+
+namespace 'yardoc' do
+  desc 'Generate documentation'
+  task 'generate' do
+    puts `yardoc lib/*`
+  end
+
+  desc 'List undocumented elements'
+  task 'undoc' do
+    puts `yardoc stats --list-undoc lib/*`
+  end
+end
+
+namespace 'eol' do
+  desc 'Replace CRLF with LF.'
+  task :dos2unix, [:pattern] do |_t, args|
+    path_list = Dir.glob(args.pattern || '**/*.{rb,rake}', File::FNM_EXTGLOB)
+    counter = 0
+    path_list.each do |path|
+      next unless File.file?(path)
+
+      counter += 1
+      puts "Handling `#{path}`..."
+      content = File.read(path, mode: 'rb')
+      content.gsub!(/\r\n/, "\n")
+      File.write(path, content, mode: 'wb')
+    end
+    puts "Handled #{counter} files."
+  end
+end

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'command_bot'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start

data/command_bot.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'lib/command_bot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'command_bot'
+  spec.version       = CommandBot::VERSION
+  spec.authors       = ['Fizvlad']
+  spec.email         = ['fizvlad@mail.ru']
+
+  spec.summary       = 'General purpose text bots'
+  spec.homepage      = 'https://github.com/fizvlad/command_bot'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.5')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/fizvlad/command_bot'
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/examples/console_bot.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+
+bot = CommandBot::Bot.new(identifier: CommandBot::CommandIdentifier.primitive)
+bot.add_commands(PingCommand, HelpCommand)
+
+puts 'Awaiting input:'
+loop do
+  text = gets.chomp
+  break if text.empty?
+
+  re = bot.handle(text)
+  puts re if re
+end

data/examples/helper.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'command_bot'
+
+PingCommand = CommandBot::Command.new(
+  name: 'ping',
+  aliases: ['p'],
+  data: {
+    description: 'ping-pong',
+    description_long: 'Ping-pong.'
+  }
+) do |_bot, _arguments, _options, *_other|
+  'pong'
+end
+
+HelpCommand = CommandBot::Command.new(
+  name: 'help',
+  aliases: ['h'],
+  data: {
+    description: 'show help message',
+    description_long: 'Show help message for specified command. Shows list of ' \
+                      'command if atgument is not specified.',
+    another_info: 'you can pass any data here'
+  }
+) do |bot, arguments, _options, *_other|
+  commands = if arguments.empty?
+               bot.commands
+             else
+               bot.commands.select { |e| arguments.include? e.name }
+             end
+
+  help_line = if arguments.empty?
+                proc do |e|
+                  "#{e.name} (also known as #{e.aliases.join(', ')}) " \
+                  "- #{e.data[:description]}"
+                end
+              else
+                proc do |e|
+                  "#{e.name} (also known as #{e.aliases.join(', ')}) " \
+                  "- #{e.data[:description]}\n#{e.data[:description_long]}"
+                end
+              end
+
+  <<~HELP
+    Commands list:
+    #{commands.map(&help_line).join("\n")}
+  HELP
+end

data/examples/two_console_bots.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+
+command_identifier1 = CommandBot::CommandIdentifier.default(prefix: '!')
+command_identifier2 = CommandBot::CommandIdentifier.default(prefix: '?')
+
+bot1 = CommandBot::Bot.new(identifier: command_identifier1, log_level: Logger::DEBUG)
+bot1.add_commands(PingCommand, HelpCommand)
+
+bot2 = CommandBot::Bot.new(identifier: command_identifier2)
+bot2.add_commands(HelpCommand, PingCommand)
+
+puts 'Awaiting input:'
+loop do
+  text = gets.chomp
+  break if text.empty?
+
+  re1 = bot1.handle(text)
+  puts re1 if re1
+
+  re2 = bot2.handle(text)
+  puts re2 if re2
+end

data/lib/command_bot.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'command_bot/version'
+require 'command_bot/command'
+require 'command_bot/command_call'
+require 'command_bot/command_identifier'
+require 'command_bot/bot'
+
+# Main module.
+module CommandBot; end

data/lib/command_bot/bot.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module CommandBot
+  # Main class.
+  class Bot
+    # Initialize new bot.
+    # @paran identifier [CommandIdentifier] defaults to {CommandIdentifier.default}.
+    # @param logger [Logger]
+    # @param log_level [Logger::Severity]
+    # @param command_not_found [Proc] process to execute when command can't be
+    #   identified. Accepts single argument of {CommandCall}. Defaults to returning +nil+.
+    def initialize(identifier: nil, logger: nil, log_level: Logger::INFO, command_not_found: nil)
+      @identifier = identifier || CommandIdentifier.default
+      @command_not_found = command_not_found || proc { |_command_call| nil }
+
+      @commands = []
+
+      log_formatter = proc do |severity, datetime, progname, msg|
+        "[#{datetime}] #{severity} - #{progname || object_id}:\t #{msg}\n"
+      end
+      @logger = logger || Logger.new(STDOUT, formatter: log_formatter)
+      @logger.level = log_level
+    end
+
+    # @return [Array<Command>]
+    attr_reader :commands
+
+    # @param name [String]
+    # @return [Command, nil]
+    def find_command(name)
+      logger.debug "Searching for command `#{name}`"
+      commands.find { |c| c.name_matches?(name) }
+    end
+
+    # Add new commands.
+    # @param commands [Command]
+    def add_commands(*commands)
+      logger.debug "Adding #{commands.size} new commands"
+      all_aliases_array = all_aliases
+      commands.each { |c| add_command_unless_alias_is_in_array(c, all_aliases_array) }
+    end
+
+    # Remove commands.
+    # @param commands [Command, String]
+    def remove_commands(*commands)
+      logger.debug "Removing #{commands.size} commands"
+      command_names = commands.map { |c| c.is_a?(String) ? c : c.name }
+      @commands.reject! { |ec| ec.name_matches?(*command_names) }
+    end
+
+    # Handle message.
+    # @param text [String] message text.
+    # @param data [Hash] additional data which should be passed to handler procedure.
+    # @return [void, nil] result depends on handler of command.
+    def handle(text, data = {})
+      logger.debug "Handling text: `#{text}` with additional data: #{data}"
+      command_call = identify_command_call(text, data)
+      return nil if command_call.nil? # Not a command call, so not handling.
+
+      handle_command_call(command_call)
+    end
+
+    # Hadnle {CommandCall}.
+    # @param command_call [CommandCall]
+    # @return [void, nil] result depends on handler of command.
+    def handle_command_call(command_call)
+      logger.debug "Hadnling command call: #{command_call}"
+      if command_call.command
+        execute_command_call(command_call)
+      else
+        command_not_found(command_call)
+      end
+    end
+
+    private
+
+    # @return [Logger]
+    attr_reader :logger
+
+    # @return [Array<String>]
+    def all_aliases
+      re = @commands.map(&:all_aliases)
+      re.flatten!
+      re
+    end
+
+    # @note modifies +all_aliases_array+
+    def add_command_unless_alias_is_in_array(command, all_aliases_array)
+      command_aliases = command.all_aliases
+      intersection = all_aliases_array & command_aliases
+      if intersection.empty?
+        @commands << command
+        all_aliases_array.concat(command_aliases)
+      else
+        logger.warn "Command #{command.name} will not be added due to name intersection!"
+      end
+    end
+
+    # @return [CommandCall, nil]
+    def identify_command_call(text, data)
+      @identifier.call(self, text, data)
+    end
+
+    # @return [void]
+    def execute_command_call(command_call)
+      command_call.execute
+      # NOTE: it is possible to execute it from here, but IHMO command_call should
+      #   be able to execute itself.
+    end
+
+    def command_not_found(command_call)
+      @command_not_found.call(command_call)
+    end
+  end
+end

data/lib/command_bot/command.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module CommandBot
+  # Stores command handler.
+  class Command
+    # Initalize new command.
+    # @param name [String]
+    # @param aliases [Array<String>]
+    # @param data [Hash]
+    # @yieldparam bot [Bot]
+    # @yieldparam arguments [Array<String>]
+    # @yieldparam options [Hash<String, String>]
+    # @yieldparam other [Array<void>]
+    # @yieldreturn [void]
+    def initialize(name: '', aliases: [], data: {}, &handler)
+      @name = name
+      @aliases = aliases
+      @data = data
+
+      @handler = handler
+    end
+
+    # @return [String]
+    attr_reader :name
+
+    # @return [Array<String>]
+    attr_reader :aliases
+
+    # @return [Hash]
+    attr_reader :data
+
+    # @return [Proc]
+    attr_reader :handler
+
+    # @return [Array<String>]
+    def all_aliases
+      aliases + [name]
+    end
+
+    # @param names [Array<String>]
+    # @return [Boolean]
+    def name_matches?(*names)
+      all_aliases.any? { |a| names.include?(a) }
+    end
+  end
+end

data/lib/command_bot/command_call.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module CommandBot
+  # Stores command call information.
+  class CommandCall
+    # New command call.
+    # @param bot [Bot]
+    # @param text [String]
+    # @param data [Hash]
+    def initialize(bot, text, data)
+      @bot = bot
+      @text = text
+      @data = data
+
+      @command = nil
+      @arguments = []
+      @options = {}
+    end
+
+    # @return [Bot]
+    attr_reader :bot
+
+    # @return [String]
+    attr_reader :text
+
+    # @return [Hash]
+    attr_reader :data
+
+    # @return [Command, nil] +nil+ if command can't be found.
+    attr_accessor :command
+
+    # @return [Array<String>]
+    attr_accessor :arguments
+
+    # @return [Hash<String, String>]
+    attr_accessor :options
+
+    # Executes command.
+    # @return [void]
+    def execute
+      raise 'Command not identified!' if command.nil?
+
+      command.handler.call(bot, arguments, options, data)
+    end
+
+    # @return [String]
+    def to_s
+      if command.nil?
+        "COMMAND_NOT_FOUND(`#{text}`)"
+      else
+        arg_str = arguments.join(', ')
+        opt_str = options.map { |k, v| "#{k}: #{v}" }.join(', ')
+        "#{command.name}[#{arg_str}]{#{opt_str}}"
+      end
+    end
+  end
+end

data/lib/command_bot/command_identifier.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module CommandBot
+  # Stores command call information.
+  class CommandIdentifier
+    # Create new identifier.
+    # @yieldparam bot [Bot]
+    # @yieldparam text [String]
+    # @yieldparam data [Hash]
+    # @yieldreturn [CommandCall, nil] +nil+ if not a command.
+    def initialize(&identifier)
+      @identifier = identifier
+    end
+
+    # Call identifier process.
+    # @param text [String]
+    # @param data [Hash]
+    # @return [CommandCall, nil] +nil+ if not a command.
+    def call(bot, text, data)
+      @identifier.call(bot, text, data)
+    end
+
+    # @param prefix [String] command prefix.
+    # @param disallow_whitespace [Boolean] whether to disallow whitespace
+    #   between prefix and command name.
+    # @param o_prefix [String] prefix of option key.
+    # @param o_separator [String] separator between option and value.
+    # @return [CommandIdentifier]
+    def self.default(prefix: '', disallow_whitespace: false, o_prefix: '--', o_separator: '=') # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      new do |bot, text_original, data|
+        command_call = CommandCall.new(bot, text_original, data)
+        text = text_original.dup
+
+        # Not a command if got prefix and text do not start with it
+        next nil unless prefix.empty? || text.delete_prefix!(prefix)
+        # Check for whitespace
+        next nil if disallow_whitespace && text.lstrip!
+
+        words = text.split
+        next nil if words.empty? # Just a prefix
+
+        command_name = words.shift
+        command_name&.downcase! # Usually commands should not depend on case, so downcasing
+
+        options = _get_options(words, o_prefix, o_separator)
+
+        command_call.command = bot.find_command(command_name)
+        command_call.arguments = words # Everything left is considered to be arguments
+        command_call.options = options
+        command_call
+      end
+    end
+
+    # @return [CommandIdentifier] primitive optionless identifier.
+    def self.primitive
+      new do |bot, text, data|
+        command_call = CommandCall.new(bot, text, data)
+        words = text.split
+        command_call.command = bot.find_command(words.shift || '')
+        command_call.arguments = words
+        command_call.options = {}
+        command_call
+      end
+    end
+
+    # Utility method to get options hash from words array (it *will* be modified).
+    # @param words [Array<String>]
+    # @param prefix [String] prefix of option key.
+    # @param separator [String] separator between option and value.
+    def self._get_options(words, prefix, separator)
+      options = {}
+      while words.first&.start_with?(prefix)
+        str = words.shift
+        str.downcase!
+        str.delete_prefix! prefix
+
+        # Need to check for splitter in key
+        key, *, value = str.partition(separator)
+
+        # Following line allows writing '!command --key = val' with words=['--key', '=', 'val']
+        *, value = words.shift(2) if value.empty? && words.first == separator
+
+        options[key] = value || ''
+      end
+      options
+    end
+  end
+end

data/lib/command_bot/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module CommandBot
+  # Library version.
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: command_bot
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Fizvlad
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-14 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- fizvlad@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- command_bot.gemspec
+- examples/console_bot.rb
+- examples/helper.rb
+- examples/two_console_bots.rb
+- lib/command_bot.rb
+- lib/command_bot/bot.rb
+- lib/command_bot/command.rb
+- lib/command_bot/command_call.rb
+- lib/command_bot/command_identifier.rb
+- lib/command_bot/version.rb
+homepage: https://github.com/fizvlad/command_bot
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fizvlad/command_bot
+  source_code_uri: https://github.com/fizvlad/command_bot
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.0.pre2
+signing_key: 
+specification_version: 4
+summary: General purpose text bots
+test_files: []