command_bot 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce3490ea16754fc8c40d25e6a1c88ca15ecbb2457bb380b466c47797ad8d0af3
-  data.tar.gz: 7aff185e761c5770f853cb78053dc57b81c9ecc388ad61e93642ee98e8f2121d
+  metadata.gz: c0967f34f9d65155da4467d04c8dbcaf5c1772d925a73f6892dab25e257e3440
+  data.tar.gz: 543fc95cc45e431bfaaf0a6c0ae93a40b8afa5239b622982c8a9f3ffd2f2e053
 SHA512:
-  metadata.gz: b0ec894158f3d357ef9267c40549b5b8869184eda4b4beb7a30817ddd3440744108e0fa80d57a921ce493375dc050c40eed7f7e4916d808d8cdb5a77c2cc95a8
-  data.tar.gz: 831ea48cfaf594e2375a651798a1a0f775c09bbcbb6854a4a383674e87f2a0296ad75a22c190717f87bd17abfbd4210eb065da94cb839002b133ab35d80043e4
+  metadata.gz: 74a2a881ef1ba216a3be8f0bb24b0b3eef659bb81b38258535db3b41af5f7fb034656d6bfbff0c56e616b75d740ee1d9bc9e1ff391bb22230745dc23c205cbc8
+  data.tar.gz: '08e77136146597ebe9d774a8d143c07c7ae0e318cd725c918ff9e10ff3a88215ee51c906c6db5f01f81d0b7cec1f0b3fb69f6cad85010fcf487d6f64a1eb5f6f'

data/examples/helper.rb

@@ -1,49 +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
+# 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, _data|
+  '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, _data|
+  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/lib/command_bot/bot.rb

@@ -1,117 +1,120 @@
-# 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
+# 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
+
+    # @return [CommandIdentifier]
+    attr_reader :identifier
+
+    # @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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_bot
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Fizvlad
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-14 00:00:00.000000000 Z
+date: 2020-06-17 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: