cinch-bot_template 0.1.0

data/lib/cinch/bot_template/classes/hello.rb

@@ -0,0 +1,60 @@
+require 'thor'
+require 'highline'
+
+require 'cinch/bot_template/templates/hello'
+module Cinch
+  module BotTemplate
+    module Classes
+      class Hello
+        def initialize(directory: Pathname('.'), shell:, options: {})
+          @hl        = HighLine.new($stdin, $stderr, 80)
+          @opts      = Hash.new { |hash, key| hash[key] = {} }
+          @directory = directory
+          @shell = shell
+          @options   = options
+        end
+
+
+        def get_001_bot_name
+          @hl.say "What's the bot's name"
+          @opts['bot']['nick'] = @hl.ask "    > ", String
+        end
+
+        # @note What the executable file will be named + .rb
+        def get_002_bot_file
+          @hl.say "What should the executable file be named."
+          @hl.say "Use a hyphen by itself '-' to output to stdout "
+          @hl.say "instead of a file."
+          @hl.say "The generator will add .rb automatically."
+          filename = @hl.ask "    > ", String
+          if filename == '-'
+            @opts['stdout'] = true
+            return
+          end
+          @opts['bot']['file'] = filename.include?('.rb') ? filename : filename + '.rb'
+        end
+
+
+        def generate
+          meths = self.methods.select { |x| x =~ /^get_[0-9]+_.*/ }
+          meths.sort! { |m, n| m.to_s.gsub(/^get_([0-9]+)_.*/, '\1').to_i <=> n.to_s.gsub(/^get_([0-9]+)_.*/, '\1').to_i }
+          meths.each do |m|
+            self.send(m)
+          end
+          @hl.say "Generating..."
+          tpl = Cinch::BotTemplate::Templates::Hello.new.generate(nick: @opts['bot']['nick'])
+          Cinch::BotTemplate.show_wait_spinner(5) do
+            if @opts.fetch('stdout', nil)
+              puts tpl
+            else
+              filename = @opts.dig('bot', 'file')
+              open filename, 'a+' do |fd|
+                fd.puts tpl
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cinch/bot_template/classes/plugin.rb

@@ -0,0 +1,51 @@
+require 'thor'
+require 'highline'
+
+require 'cinch/bot_template/templates/plugin'
+module Cinch
+  module BotTemplate
+    module Classes
+      class Plugin
+        def initialize(directory: Pathname('.').to_s, shell:, options:, all: false)
+          @hl        = HighLine.new($stdin, $stderr, 80)
+          @opts      = Hash.new { |hash, key| hash[key] = {} }
+          @all       = all
+          @shell = shell
+          @directory = directory
+          @options   = options
+        end
+
+        # @param [String] file_path File path to config as string to parse
+        def parse_config_path(file_path)
+          path = Pathname(file_path)
+          path = File.expand_path(path)
+          path.to_s
+        end
+
+        def get_001_plugin_names
+          @hl.say "What's the plugin name(s)?"
+          @hl.say "Each name you put here will have 'Plugin' appended to it."
+          @hl.say "Each name will become a separate plugin file"
+          @opts['plugin_names'] = @hl.ask "    > ", -> (str) { str.split(' ') }
+        end
+
+
+        def generate(directory:)
+          meths = self.methods.select { |x| x =~ /^get_[0-9]+_.*/ }
+          meths.sort! { |m, n| m.to_s.gsub(/^get_([0-9]+)_.*/, '\1').to_i <=> n.to_s.gsub(/^get_([0-9]+)_.*/, '\1').to_i }
+          meths.each do |m|
+            self.send(m)
+          end
+          @hl.say "Generating..."
+          plugins = Cinch::BotTemplate::Templates::Plugin.generate(plugin_names: @opts['plugin_names'])
+          FileUtils.mkpath(directory.join('plugins'))
+          plugins.each do |plugin, text|
+            open Pathname(directory).join('plugins', plugin), 'w' do |fd|
+              fd.puts text
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cinch/bot_template/desc/bot.rb

@@ -0,0 +1,22 @@
+module Cinch
+  module BotTemplate
+    module Descs
+      module Bot
+        def self.Gen
+          <<~GEN
+          '#{Pathname($PROGRAM_NAME).basename} bot gen' will generate a bot file,
+          a executable file that has the basics of a cinch bot inside.
+          \#$
+          If you're looking to generate a whole bot, config, plugins,
+          bot file, logs, then use '#{Pathname($PROGRAM_NAME).basename} gen' itself.
+          \#$
+          See the help on '#{Pathname($PROGRAM_NAME).basename} help gen'
+          for information on using having a bot connect to
+          multiple servers/networks.
+
+          GEN
+        end
+      end
+    end
+  end
+end

data/lib/cinch/bot_template/desc/gen.rb

@@ -0,0 +1,27 @@
+require 'paint'
+module Cinch
+  module BotTemplate
+    module Descs
+      module Gen
+        module_function
+
+        def Gen
+          ERB.new(
+          <<~GEN
+          --'<%= Paint['#{Pathname($PROGRAM_NAME).basename} gen', 'orange', :bold ] %>' will prompt for information
+          --then will generate the following when given no other options.
+          --* executable bot file
+          --* config file
+          --* optimal directory structure
+          <%= Paint['MULTI SERVER USE', 'white', :bold] %>:
+          --If '--multi-server' or '-m' is used, the generator will
+          --output a config and/or bot file that is set in a way to
+          --allow multiple networks/servers.
+          GEN
+          ).result
+        end
+      end
+
+    end
+  end
+end

data/lib/cinch/bot_template/desc/hello.rb

@@ -0,0 +1,17 @@
+module Cinch
+  module BotTemplate
+    module Descs
+      module Hello
+        module_function
+
+        def Gen
+          <<~GEN
+            '#{Pathname($PROGRAM_NAME).basename} hello' generates a simple one file
+            --that allows you to start a bot up in seconds.
+          GEN
+        end
+      end
+
+    end
+  end
+end

data/lib/cinch/bot_template/desc/plugin.rb

@@ -0,0 +1,22 @@
+require 'paint'
+module Cinch
+  module BotTemplate
+    module Descs
+      module Plugin
+        module_function
+
+        def Gen
+          ERB.new(
+              <<~GEN
+                --'<%= Paint['#{Pathname($PROGRAM_NAME).basename} plugin gen', 'orange', :bold] %>'
+                --will prompt for information,
+                --then will start generating either one or multiple plugin files,
+                --based on how many plugin names it was given.
+          GEN
+          ).result
+        end
+      end
+
+    end
+  end
+end

data/lib/cinch/bot_template/main/bot.rb

@@ -0,0 +1,19 @@
+require 'cinch/bot_template/classes/bot'
+require 'cinch/bot_template/main/desc'
+require 'thor'
+
+module Cinch
+  module BotTemplate
+
+    class Bot < Thor
+
+      method_option 'multi-server', type: :boolean, default: false, aliases: %w(-m), hide: true
+      long_desc Descs::Bot.Gen
+      desc 'gen [options]', 'Generate the executable for a bot'
+      def gen
+        generator = Cinch::BotTemplate::Classes::Bot.new(options)
+        generator.generate
+      end
+    end
+  end
+end

data/lib/cinch/bot_template/main/cli.rb

@@ -0,0 +1,51 @@
+require 'thor'
+require 'highline'
+require 'cinch/bot_template/classes/gen_init'
+require 'cinch/bot_template/classes/bot'
+require 'cinch/bot_template/classes/plugin'
+require 'cinch/bot_template/classes/config'
+module Cinch
+  module BotTemplate
+    module CLI
+      class Base
+        def initialize(shell:, options:)
+          @hl      = HighLine.new($stdin, $stderr, 80)
+          @opts    = Hash.new { |hash, key| hash[key] = {} }
+          @options = options
+          @shell   = shell
+        end
+
+        def generate
+          init = Cinch::BotTemplate::Classes::Init.new(
+              options: @options,
+              shell:   @shell,
+              all:     true
+          )
+          init.generate
+          directory = init.directory
+
+          config = Cinch::BotTemplate::Classes::Config.new(
+              options: @options,
+              shell:   @shell,
+              all:     true
+          )
+          cfg_path = config.generate(directory)
+
+          bot = Cinch::BotTemplate::Classes::Bot.new(
+              options: @options,
+              shell:   @shell,
+              all:     true
+          )
+          bot.generate(directory: directory, config_file: cfg_path)
+
+          plugins = Cinch::BotTemplate::Classes::Plugin.new(
+              shell: @shell,
+              options: @options,
+              all:     true
+          )
+          plugins.generate(directory: directory)
+        end
+      end
+    end
+  end
+end

data/lib/cinch/bot_template/main/config.rb

@@ -0,0 +1,20 @@
+require 'cinch/bot_template/classes/bot'
+require 'cinch/bot_template/main/desc'
+require  'thor'
+
+module Cinch
+  module BotTemplate
+
+    class Config < Thor
+
+      desc 'gen [options]', 'Generate the executable for a bot'
+      method_option 'multi-server', type: :boolean, default: false, aliases: %w(-m), required: false, hide: true
+
+      long_desc Cinch::BotTemplate::Descs::Plugin.Gen
+      def gen(dir)
+        generator = Cinch::BotTemplate::Classes::Config.new(options: options, shell: self.shell)
+        generator.generate(Pathname(dir))
+      end
+    end
+  end
+end

data/lib/cinch/bot_template/main/desc.rb

@@ -0,0 +1,10 @@
+module Cinch
+  module BotTemplate
+    module Descs
+      autoload :Bot, 'cinch/bot_template/desc/bot'
+      autoload :Gen, 'cinch/bot_template/desc/gen'
+      autoload :Hello, 'cinch/bot_template/desc/hello'
+      autoload :Plugin, 'cinch/bot_template/desc/plugin'
+    end
+  end
+end

data/lib/cinch/bot_template/main/plugin.rb

@@ -0,0 +1,15 @@
+require 'cinch/bot_template/classes/plugin'
+require 'thor'
+
+module Cinch
+  module BotTemplate
+    class Plugin < Thor
+      long_desc Cinch::BotTemplate::Descs::Plugin.Gen
+      desc 'gen [options]', 'Generate a plugin'
+      def gen(dir)
+        generator = Cinch::BotTemplate::Classes::Plugin.new(directory: dir, options: options)
+        generator.generate
+      end
+    end
+  end
+end

data/lib/cinch/bot_template/main/spinner.rb

@@ -0,0 +1,22 @@
+module Cinch
+  module BotTemplate
+    module_function
+
+    def show_wait_spinner(fps = 10)
+      chars   = %w[| / - \\]
+      delay   = 1.0 / fps
+      iter    = 0
+      spinner = Thread.new do
+        while iter do # Keep spinning until told otherwise
+          print chars[(iter += 1) % chars.length]
+          sleep delay
+          print "\b"
+        end
+      end
+      yield.tap {# After yielding to the block, save the return value
+        iter = false # Tell the thread to exit, cleaning up after itself…
+        spinner.join # …and wait for it to do so.
+      } # Use the block's return value as the method's
+    end
+  end
+end

data/lib/cinch/bot_template/main/thor.rb

@@ -0,0 +1,102 @@
+require 'paint'
+class Thor
+  class << self
+    def command_help(shell, command_name)
+      meth    = normalize_command_name(command_name)
+      command = all_commands[meth]
+      handle_no_command_error(meth) unless command
+
+      shell.say "USAGE ", ['white', :bold]
+      shell.say "\b:"
+      shell.say "  #{banner(command)}"
+      class_options_help(shell, nil => command.options.values)
+      if command.long_description
+        shell.say "DESCRIPTION ", ['white', :bold]
+        shell.say "\b:"
+        shell.print_wrapped(command.long_description)
+      else
+        shell.say command.description
+      end
+    end
+
+    alias_method :task_help, :command_help
+  end
+  module Base
+    module ClassMethods
+      def print_options(shell, options, group_name = nil)
+        return if options.empty?
+
+        list    = []
+        padding = options.map { |o| o.aliases.size }.max.to_i * 4
+
+        options.each do |option|
+          next if option.hide
+          item = [option.usage(padding)]
+          item.push(option.description ? "# #{option.description}" : "")
+
+          list << item
+          list << ["", "# Default: #{option.default}"] if option.show_default?
+          list << ["", "# Possible values: #{option.enum.join(', ')}"] if option.enum
+        end
+
+        shell.say(group_name ? "#{group_name} options:" : "Options:") unless list.empty?
+        shell.print_table(list, :indent => 2) unless list.empty?
+        #shell.say ""
+      end
+    end
+
+  end
+  module Shell
+    class Basic
+      def prepare_message(message, *color, paint: true)
+        case paint
+        when true
+          spaces = "  " * padding
+          spaces + Paint[message.to_s, *color]
+        when false
+          spaces = "  " * padding
+          spaces + set_color(message.to_s, *color)
+        else
+          spaces = "  " * padding
+          spaces + Paint[message.to_s, *color]
+        end
+
+      end
+
+      # Say (print) something to the user. If the sentence ends with a whitespace
+      # or tab character, a new line is not appended (print + flush). Otherwise
+      # are passed straight to puts (behavior got from Highline).
+      #
+      # ==== Example
+      # say("I know you knew that.")
+      #
+      def say(message = "", color = nil, force_new_line = (message.to_s !~ /( |\t)\Z/), paint: true)
+        buffer = prepare_message(message, *color, paint: paint)
+        buffer << "\n" if force_new_line && !message.to_s.end_with?("\n")
+
+        stdout.print(buffer)
+        stdout.flush
+      end
+
+      # @note Override Thor::Shell::Basic.print_wrapped
+      # @overload Thor::Shell::Basic.print_wrapped
+      #   1. Replace 6 - with 6 spaces
+      #   2. Replace 4 - with 4 spaces
+      #   3. Replace 2 - with 2 spaces
+      #   4. Replace #$ at the beginning of lines
+      #     with '\n'
+      def print_wrapped(message, options = {})
+        message.lstrip!
+        message.gsub!(/\n\s+/, "\n")
+        message = message.split("\n")
+        message.each do |line|
+          line.gsub!(/^------/, ' ' * 6) if line[0..5] == '-' * 6
+          line.gsub!(/^----/, ' ' * 4) if line[0..3] == '-' * 4
+          line.gsub!(/^--/, ' ' * 2) if line[0..1] == '-' * 2
+          line.gsub!(/^#\$/, "\n")
+          stdout.puts line
+        end
+      end
+    end
+  end
+end