cinch-bot_template 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 056c79a1ad9b78b1ed2a88a977f8fdc1d22950b14cacbc344b57a710ac4a2287
+  data.tar.gz: 17450f9825158342a1a6d94b3867fc1654439b271dd0780867d477817302ad7a
+SHA512:
+  metadata.gz: f61ab09e67e842de45b7e8aeaac15982a9e7beb5c45a7a17d25b96a27c3049b7f6c49d392bafd63032d816acc0e6d218813f3ac246665fe4857d3cbcebe3c4aa
+  data.tar.gz: c2fde1de43b123e5eed92aa16d317ecd306db0b09e71eb8b274a91cfea843309426f592517d5bb8e2b51823b7b4ee6efe36f7b7f6ef950202de8a97ea4ab66bb

data/.gitignore

@@ -0,0 +1,28 @@
+# Because this is a gem, ignore Gemfile.lock:
+
+Gemfile.lock
+
+# And because this is Ruby, ignore the following
+#  (source: https://github.com/github/gitignore/blob/master/Ruby.gitignore):
+
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Gemfile.lock
+/vendor/bundle
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+/.idea/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c)  Ken Spencer <me@iotaspencer.me>
+
+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,38 @@
+# cinch-bot_template
+
+
+[![Gem](https://img.shields.io/gem/v/cinch-bot_template.svg?style=for-the-badge)](https://rubygems.org/gems/cinch-bot_template)
+
+[![Gem](https://img.shields.io/gem/dt/cinch-bot_template.svg?style=for-the-badge)](https://rubygems.org/gems/cinch-bot_template)
+[![Gem](https://img.shields.io/gem/dtv/cinch-bot_template.svg?style=for-the-badge)](https://rubygems.org/gems/cinch-bot_template)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
+
+[![forthebadge](https://forthebadge.com/images/badges/uses-badges.svg)](https://forthebadge.com)
+[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com)
+[![forthebadge](https://forthebadge.com/images/badges/uses-git.svg)](https://forthebadge.com)
+
+## Contact
+
+[![E-mail](https://img.shields.io/badge/Email-Me-green.svg?style=for-the-badge)](mailto:me@iotaspencer.me)
+[![Twitter Follow](https://img.shields.io/twitter/follow/IotaEcode.svg?label=Follow%20Me%20on%20Twitter&style=for-the-badge)](https://twitter.com/IotaEcode)
+
+[![Website](https://img.shields.io/website-up-down-green-red/https/iotaspencer.me.svg?label=My%20Site%20-%20IotaSpencer%2Eme&style=for-the-badge)](https://iotaspencer.me)
+
+[![Website](https://img.shields.io/website/http/shields.io.svg?label=cinch-bot_template%20on%20IotaSpencer.me&style=for-the-badge)](https://iotaspencer.me/projects/cinch-bot_template)
+
+## Usage
+
+### Generate a Hello World Skeleton
+
+
+```shell
+$ cinch-mktpl hello
+```
+```
+What's the bot's name
+    > Cinch
+    
+What should the executable file be named.
+The generator will add .rb automatically.
+    > start
+```

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake'
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/bin/cinch-mktpl

@@ -0,0 +1,4 @@
+#! /usr/bin/env ruby
+
+require 'cinch/bot_template'
+Cinch::BotTemplate::CLI::App.start(ARGV)

data/cinch-bot_template.gemspec

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'pathname'
+require 'cinch/bot_template/version'
+
+Gem::Specification.new do |s|
+  s.name          = "cinch-bot_template"
+  s.version       = Cinch::BotTemplate::VERSION
+  s.authors       = ["Ken Spencer"]
+  s.email         = ["me@iotaspencer.me"]
+  s.homepage      = "https://github.com/IotaSpencer/cinch-bot_template"
+  s.summary       = "Generate cinch bot skeletons"
+  s.description   = s.summary
+  s.license       = 'MIT'
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test)/})
+  end
+  s.platform      = Gem::Platform::RUBY
+  s.require_paths = ['lib']
+  s.executables = Pathname('./bin').entries.map(&:to_s).delete_if { |x| %w(. ..).include?(x) }
+
+  s.required_ruby_version = ['>= 2.3', '<= 3.0']
+
+
+  s.add_runtime_dependency 'cinch', '~> 2.3'
+  s.add_runtime_dependency 'activesupport', '~> 5.1'
+  s.add_runtime_dependency 'thor', '~> 0.20'
+  s.add_runtime_dependency 'highline', '~> 1.7', '>= 1.7.10'
+  s.add_runtime_dependency 'paint', '>= 2.0.1', '<= 3.0'
+  s.add_runtime_dependency 'require_all', '~> 2.0'
+  s.add_development_dependency 'bundler', '~> 1.16'
+end

data/lib/cinch/bot_template.rb

@@ -0,0 +1 @@
+require 'cinch/bot_template/cinch-bot_template'

data/lib/cinch/bot_template/cinch-bot_template.rb

@@ -0,0 +1,60 @@
+require 'thor'
+require 'cinch/bot_template/main/thor'
+require 'cinch/bot_template/main/desc'
+require 'cinch/bot_template/main/plugin'
+require 'cinch/bot_template/main/bot'
+require 'cinch/bot_template/classes/hello'
+require 'cinch/bot_template/main/config'
+require 'cinch/bot_template/classes/exceptions'
+require 'cinch/bot_template/main/cli'
+require 'cinch/bot_template/main/spinner'
+
+module Cinch
+  module BotTemplate
+    module CLI
+      class App < Thor
+        def self.exit_on_failure?
+          true
+        end
+        class_option(:debug, type: :boolean, hide: true)
+
+        map %w[--version -v] => :__print_version
+        desc '--version, -v', 'Print the version'
+
+        # Prints version string
+        # @return [NilClass] nil
+        def __print_version
+          puts Cinch::BotTemplate::VERSION
+        end
+
+        desc 'gen [DIR] [options]', 'Generate a skeleton of a full bot'
+        method_option 'multi-server', type: :boolean, default: false, aliases: %w(-m), required: false, hide: true
+
+        long_desc Cinch::BotTemplate::Descs::Gen.Gen
+
+        def gen
+          generator = Cinch::BotTemplate::CLI::Base.new(shell: self.shell, options: options)
+          generator.generate
+        end
+
+        desc 'hello', 'Creates a simple hello world bot in one file'
+        long_desc Cinch::BotTemplate::Descs::Hello.Gen
+
+        def hello
+          generator = Cinch::BotTemplate::Classes::Hello.new(shell: self.shell)
+          generator.generate
+        end
+
+        desc 'plugin [command] [options]', 'Generate a plugin'
+        subcommand('plugin', Cinch::BotTemplate::Plugin)
+
+        desc 'bot [command] [options]', 'Generate a bot file'
+        subcommand('bot', Cinch::BotTemplate::Bot)
+
+        desc 'config [command] [options]', 'Generate a bot config'
+        subcommand('config', Cinch::BotTemplate::Config)
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+require 'thor'
+require 'highline'
+
+require 'cinch/bot_template/templates/bot'
+module Cinch
+  module BotTemplate
+    module Classes
+      class Bot
+        def initialize(options:, shell:, all: false)
+          @hl        = HighLine.new($stdin, $stderr, 80)
+          @opts      = Hash.new { |hash, key| hash[key] = {} }
+          @options   = options
+          @all       = all
+          @shell     = shell
+
+        end
+
+        # @note What the executable file will be named + .rb
+        def get_001_bot_file
+          @hl.say "What should the executable file be named."
+          unless @all
+            @hl.say "Use a hyphen by itself '-' to output to stdout "
+            @hl.say "instead of a file."
+          end
+
+          @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 get_002_config_file
+          @shell.say "Grabbing config path from state..."
+          @opts['config_path'] = Pathname(@directory).join(@config_file)
+        end
+
+        # @param [Pathname] directory Bot directory
+        # @param [Pathname] config_file configuration path
+        def generate(directory:, config_file:)
+          @directory = directory
+          @config_file = config_file
+          if @options.fetch(:debug, nil)
+            at_exit do
+              puts @options
+              puts @opts
+            end
+          end
+          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::Bot.new.generate(
+              multi:       @options['multi-server'],
+              config_file: @config_file,
+              )
+          if @opts.fetch('stdout', nil)
+            puts tpl
+          else
+            filename = Pathname(directory).join(@opts.dig('bot', 'file'))
+            open filename, 'a+' do |fd|
+              fd.puts tpl
+            end
+            File.chmod(775, filename)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+require 'thor'
+require 'highline'
+
+require 'cinch/bot_template/templates/config'
+module Cinch
+  module BotTemplate
+    module Classes
+      class Config
+        def initialize(options:, shell:, all: false)
+          @hl        = HighLine.new($stdin, $stderr, 80)
+          @opts      = Hash.new { |hash, key| hash[key] = {} }
+          @options   = options
+          @all       = all
+          @shell     = shell
+
+        end
+
+        # @param [String] file_path File path to config as string to parse
+        def parse_config_path(file_path)
+          begin
+            path = Pathname(file_path)
+            path = File.expand_path(path)
+            path.to_s
+          rescue
+            at_exit do
+              puts "Could not parse config path. Exiting.."
+            end
+
+            exit 1
+          end
+
+        end
+
+        def get_001_bot_networks
+          if @options['multi-server']
+            @hl.say "What networks? "
+            nets     = {}
+            networks = @hl.ask "> " do |q|
+              q.gather = /#\$/
+            end
+            networks.each do |network|
+              nets[network] = @hl.ask("Server for #{network}?")
+            end
+            @opts['bot']['networks'] = nets
+          else
+            @hl.say "Server "
+            server                 = @hl.ask "> "
+            @opts['bot']['server'] = server
+          end
+
+        end
+
+        # @note The bot's nickname
+        def get_002_bot_name
+          @hl.say "What's the bot's main nickname"
+          @opts['bot']['nick'] = @hl.ask "    > ", String
+        end
+
+
+        def generate(directory = Pathname('.'))
+          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::Config.new.generate(
+              nick:     @opts.dig('bot', 'nick'),
+              multi:    @options.dig('multi-server'),
+              networks: @options.dig('multi-server') ? @opts.dig('bot', 'networks') : @opts.dig('bot', 'server')
+
+          )
+          if @opts.fetch('stdout', nil)
+            puts tpl
+          else
+            filename = directory.join(@opts.dig('bot', 'nick')+'.yml')
+            open filename, 'a+' do |fd|
+              fd.puts tpl
+            end
+            filename
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Cinch
+  module BotTemplate
+    module Exceptions
+      class InvalidInputError < ArgumentError
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+require 'paint'
+require 'pathname'
+module Cinch
+  module BotTemplate
+    module Classes
+      class Init
+        attr :directory
+
+        def initialize(options:, shell:, all:)
+          @hl      = HighLine.new($stdin, $stderr, 80)
+          @opts    = Hash.new { |hash, key| hash[key] = {} }
+          @options = options
+          @all     = all
+          @shell   = shell
+        end
+
+        # @note There's more a format on return of [parsed,input]
+        # @overload check_path
+        #   Success => [parsed,input]
+        #   Error   => [parsed,input,error]
+        #   Error+  => [parsed,input,error,varstring,varstring,varstring]
+        # @param [String] path Check path for existence.
+        # @return [Array<Boolean,String>] if there was an error
+        # @return [Array<String>] path if successful
+        def check_path(path)
+          current_dir   = Pathname('.').expand_path.realdirpath
+          home_dir      = Pathname('~').expand_path.realdirpath
+          path_string   = path
+          path_instance = Pathname(path)
+          path_full     = Pathname(path).expand_path.realdirpath
+
+          if current_dir == home_dir and path_full == home_dir or path_string == '~'
+            abort Paint['Error', 'red', :bold] + ': Will not create files in user home, use a subdirectory'
+          else
+            [path_full, path]
+
+          end
+
+        end
+
+        def generate
+          @shell.say "What path should be used to house the bot?"
+          @shell.say "If directories don't exist, they will be created."
+          @shell.say "'~' and '.' are available for compactness"
+          @shell.say "However '~' is disallowed when using it by itself"
+          @shell.say "This is so you don't put a bot directly in your home directory."
+          @shell.say "ex: '~/bots/cinchfolder', '.' or './cinchfolder'"
+          path = @shell.ask("What directory?")
+
+          path_response = self.check_path(path)
+          if path_response.length == 2 # Success
+            parsed = path_response.first
+            if parsed.exist?
+              @directory = parsed
+            else
+              @directory = parsed
+              FileUtils.mkpath(@directory.to_s)
+
+            end
+
+          elsif path_response.length == 3 # Error
+
+          elsif path_response.length > 3 # Error+
+          end
+        end
+      end
+    end
+  end
+end