ezdrb 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 740fc8581a121fa1fde61ac5868509c8a162732465a839280b9f10e778d9e91c
-  data.tar.gz: d7a751fd9c4e9838211d955d1660e00c563c53045aa9d93868138fca66461df1
+  metadata.gz: bc9e729492ac8433318f7503f60fd273b265c0044279f8c32870bd82b977d77b
+  data.tar.gz: 795892edc5b970210d1bf4f6dd79d743d9b5280cdd83dfdf42d5d33e86947da1
 SHA512:
-  metadata.gz: b9f4df5fc5b258dfee5dd86c81e46b0f2036c120db6b38654a94413bc3d71639a64d177103480905c48f34669e7f740f921f81e646177fd695c9ca034db755a6
-  data.tar.gz: 99318ac82b6db5c90894494ea35fd1209d57a8e8e90ef25ea4716193a3d3115b6f95cea5014e2121dbdadf4a461c5357883ef079be1f17131b3b4c1a59ea3f96
+  metadata.gz: 197163660adf42d236816548e732d30f768ae667e74ce56b0f8f043579a2573d2f13346306b24fa087aa495e86723f91a72046c56fdeecc2b6aac3aec9f6f5ca
+  data.tar.gz: 13df088e3c8ed94cafd43dc63e9a366bbf4d0e1f13441532d9ed2c82e0016b49aaafd19a5cb4b30cc1547cb714b9c8cb64b48a38de53b5d9d6f4de14cc7e5ea9

data/README.md

@@ -12,6 +12,7 @@ Write Discord bots faster (Discordrb-only).
 ## Commands available
 
 * `help [command]`: Lists all commands available.
+* `event <event>`: Creates new event handler (see all available events: https://www.rubydoc.info/github/meew0/discordrb/Discordrb/EventContainer)
 * `init`: Creates a new bot in the current directory (recommended: run this in an empty directory)
 * `command <command>`: Creates a new bot command. You can find all bot commands in the *commands/* directory.
 
@@ -51,14 +52,14 @@ commands:
 
 **3\. Edit commands:**
 
-`$ vim commands/Ping.rb`. You should get something like this:
+Open `commands/Ping.rb` with your favorite text editor. You should get something like this:
 
 ```ruby
 class Ping
 
   def activate(bot)
     bot.command :ping do |event|
-      
+      puts "pong!"
     end
   end
 
@@ -69,7 +70,43 @@ Ping.new
 
 Write your command script inside the `bot.command` block.
 
-**4\. Run the bot:**
+**4\. Add event handlers to the bot:**
+
+```
+$ ezdrb event channel_create
+```
+
+All bot handlers are stored in `config/events.yml`:
+
+```
+$ cat config/events.yml
+events:
+- Channel_create
+```
+
+See all available events [here](https://www.rubydoc.info/github/meew0/discordrb/Discordrb/EventContainer).
+
+**5\. Edit handlers**
+
+Open `commands/Channel_create.rb` with your favorite text editor. You should get something like this:
+
+```ruby
+class Channel_create
+
+  def activate(bot)
+    bot.channel_create do |event|
+      puts "channel has been added"
+    end
+  end
+
+end
+
+Channel_create.new
+```
+
+Write what your bot should do when the event is triggered inside the `bot.channel_create` block.
+
+**6\. Run the bot:**
 
 Run `bot.rb`:
 
@@ -78,9 +115,11 @@ Run `bot.rb`:
 ## To do
 
 - delete a bot command
-- add events
+- ~~add events~~
 - remove events
 - run the bot from ezdrb
+- ~~use erb for code generation~~
+- rewrite commands structure
 
 
 ## License

data/ezdrb.gemspec

@@ -16,7 +16,8 @@ Gem::Specification.new do |spec|
     spec.add_development_dependency 'bundler', '~> 1.3'
     spec.add_development_dependency 'rake'
 
-    spec.add_runtime_dependency 'thor'
+    spec.add_runtime_dependency 'thor', '~> 0.20.0'
+    spec.add_runtime_dependency 'discordrb', '~> 3.2.1'
 
     spec.files         = `git ls-files`.split($/)
     spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})

data/lib/ezdrb/cli.rb

@@ -1,12 +1,10 @@
 #!/usr/bin/env ruby
 
-# ENV['DISCORDRB_NONACL'] = 'nope'
-
-# module Discordrb
-# end
-
-require 'thor'
+require 'bundler/cli'
 require 'yaml'
+require 'erb'
+require 'thor'
+
 require 'ezdrb'
 
 module Ezdrb
@@ -18,7 +16,14 @@ module Ezdrb
       var
     end
 
+    def self.load_template(template)
+      ERB.new(File.read("#{Bundler.rubygems.find_name('ezdrb').first.full_gem_path}/lib/ezdrb/templates/#{template}.erb"), 0, '%<>')
+    end
+
   end
+end
+
+module Ezdrb
 
   class CLI < Thor
 
@@ -41,12 +46,8 @@ module Ezdrb
           Dir.mkdir('events')
 
           File.open('config/bot.yml', 'w') do |file|
-            file.write(
-              <<~HEREDOC
-                prefix: '#{prefix.strip}'
-                token: '#{token.strip}'
-              HEREDOC
-            )
+            template = Helpers::load_template('BotYml').result(binding)
+            file.write(template)
           end
 
           File.open('config/commands.yml', 'w') do |file|
@@ -66,118 +67,23 @@ module Ezdrb
           end
 
           File.open('Attributes.rb', 'w') do |file|
-            file.write(
-              <<~HEREDOC
-                require 'yaml'
-
-                class Attributes
-
-                  def self.parse
-                    begin
-                      config = YAML.load_file('config/bot.yml')
-                    rescue => e
-                      puts "ERROR: Couldn't read bot.yml"
-                      exit!
-                    end
-
-                    @prefix = config['prefix']
-                    @token  = config['token']
-
-                    if @prefix.nil? then
-                      puts 'ERROR: You must set a prefix'
-                      exit!
-                    elsif @token.nil? then
-                      puts 'ERROR: You must set a token'
-                      exit!
-                    end
-
-                  end
-
-                  class << self
-                    attr_reader :prefix, :token
-                  end
-                end
-              HEREDOC
-            )
+            template = Helpers::load_template('Attributes').result(binding)
+            file.write(template)
           end
 
           File.open('Commands.rb', 'w') do |file|
-            file.write(
-              <<~HEREDOC
-                require 'yaml'
-
-                class Commands
-                  @commands = {}
-
-                  def self.parse(bot)
-                    begin
-                      commands = YAML.load_file('config/commands.yml')
-                      commands = commands.values.flatten.map(&:to_sym)
-                    rescue => e
-                      puts "ERROR: Couldn't read commands.yml"
-                      exit!
-                    end
-
-                    commands.each { |command| @commands[command] = instance_eval(File.read("commands/\#{command.downcase.capitalize}.rb")) }
-                    @commands.each { |command| command[1].activate(bot) }
-                  end
-
-                  class << self
-                    attr_reader :commands
-                  end
-                end
-              HEREDOC
-            )
+            template = Helpers::load_template('Commands').result(binding)
+            file.write(template)
           end
 
           File.open('Events.rb', 'w') do |file|
-            file.write(
-              <<~HEREDOC
-                require 'yaml'
-
-                class Events
-                  @events = {}
-
-                  def self.parse(bot)
-                    begin
-                      events = YAML.load_file('config/events.yml')
-                      events = events.values.flatten.map(&:to_sym)
-                    rescue => e
-                      puts "ERROR: Couldn't read events.yml"
-                      exit!
-                    end
-
-                    events.each { |event| @events[event] = instance_eval(File.read("events/\#{event.downcase.capitalize}.rb")) }
-                    @events.each { |event| event[1].activate(bot) }
-                  end
-
-                  class << self
-                    attr_reader :events
-                  end
-                end
-              HEREDOC
-            )
+            template = Helpers::load_template('Events').result(binding)
+            file.write(template)
           end
 
           File.open('bot.rb', 'w') do |file|
-            file.write(
-              <<~HEREDOC
-                require 'discordrb'
-
-                require_relative 'Attributes.rb'
-                require_relative 'Commands.rb'
-                require_relative 'Events.rb'
-
-                $LOAD_PATH << Dir.pwd
-
-                Attributes.parse
-                bot = Discordrb::Commands::CommandBot.new(token: Attributes.token, prefix: Attributes.prefix)
-                Commands.parse(bot)
-                Events.parse(bot)
-
-                bot.run
-              HEREDOC
-            )
+            template = Helpers::load_template('BotRun').result(binding)
+            file.write(template)
           end
         rescue => e
           say('Something went wrong while creating the project.')
@@ -213,21 +119,8 @@ module Ezdrb
         end
 
         File.open("commands/#{command_name.capitalize}.rb", 'w') do |file|
-          file.write(
-            <<~HEREDOC
-              class #{command_name.capitalize}
-
-                def activate(bot)
-                  bot.command :#{command_name} do |event|
-                    
-                  end
-                end
-
-              end
-
-              #{command_name.capitalize}.new
-            HEREDOC
-          )
+          template = Helpers::load_template('SingleCommand').result(binding)
+          file.write(template)
         end
       rescue => e
         say('Something went wrong while creating the command.')
@@ -239,7 +132,8 @@ module Ezdrb
     def event(event)
       event = event.strip.downcase
       official_events = [:ready, :disconnected, :heartbeat, :typing, :message_edit, :message_delete, :reaction_add, :reaction_remove, :reaction_remove_all, :presence, :playing, :channel_create, :channel_update, :channel_delete, :channel_recipient_add, :channel_recipient_remove, :voice_state_update, :member_join, :member_update, :member_leave, :user_ban, :user_unban, :server_create, :mention, :server_update, :server_delete, :server_emoji, :server_emoji_create, :server_emoji_delete, :private_message, :direct_message, :server_emoji_update, :raw, :unknown, :pm, :dm, :message]
-      
+      official_events.freeze
+
       if official_events.include?(event.to_sym) then
         begin
           events = YAML.load_file('config/events.yml')
@@ -263,22 +157,9 @@ module Ezdrb
             )
           end
 
-          File.open("events/#{event.downcase.capitalize}.rb", 'w') do |file|
-            file.write(
-              <<~HEREDOC
-                class #{event.downcase.capitalize}
-
-                  def activate(bot)
-                    bot.#{event} do |event|
-                      
-                    end
-                  end
-
-                end
-
-                #{event.downcase.capitalize}.new
-              HEREDOC
-            )
+          File.open("events/#{event.capitalize}.rb", 'w') do |file|
+            template = Helpers::load_template('SingleEvent').result(binding)
+            file.write(template)
           end
         rescue => e
           say('Something went wrong while creating the command.')

data/lib/ezdrb/templates/Attributes.erb

@@ -0,0 +1,29 @@
+require 'yaml'
+
+class Attributes
+
+  def self.parse
+    begin
+      config = YAML.load_file('config/bot.yml')
+    rescue => e
+      puts "ERROR: Couldn't read bot.yml"
+      exit!
+    end
+
+    @prefix = config['prefix']
+    @token  = config['token']
+
+    if @prefix.nil? then
+      puts 'ERROR: You must set a prefix'
+      exit!
+    elsif @token.nil? then
+      puts 'ERROR: You must set a token'
+      exit!
+    end
+
+  end
+
+  class << self
+    attr_reader :prefix, :token
+  end
+end

data/lib/ezdrb/templates/BotRun.erb

@@ -0,0 +1,14 @@
+require 'discordrb'
+
+require_relative 'Attributes.rb'
+require_relative 'Commands.rb'
+require_relative 'Events.rb'
+
+$LOAD_PATH << Dir.pwd
+
+Attributes.parse
+bot = Discordrb::Commands::CommandBot.new(token: Attributes.token, prefix: Attributes.prefix)
+Commands.parse(bot)
+Events.parse(bot)
+
+bot.run

data/lib/ezdrb/templates/BotYml.erb

@@ -0,0 +1,2 @@
+prefix: <%= prefix %>
+token: <%= token %>

data/lib/ezdrb/templates/Commands.erb

@@ -0,0 +1,22 @@
+require 'yaml'
+
+class Commands
+  @commands = {}
+
+  def self.parse(bot)
+    begin
+      commands = YAML.load_file('config/commands.yml')
+      commands = commands.values.flatten.map(&:to_sym)
+    rescue => e
+      puts "ERROR: Couldn't read commands.yml"
+      exit!
+    end
+
+    commands.each { |command| @commands[command] = instance_eval(File.read("commands/\#{command.downcase.capitalize}.rb")) }
+    @commands.each { |command| command[1].activate(bot) }
+  end
+
+  class << self
+    attr_reader :commands
+  end
+end

data/lib/ezdrb/templates/Events.erb

@@ -0,0 +1,22 @@
+require 'yaml'
+
+class Events
+  @events = {}
+
+  def self.parse(bot)
+    begin
+      events = YAML.load_file('config/events.yml')
+      events = events.values.flatten.map(&:to_sym)
+    rescue => e
+      puts "ERROR: Couldn't read events.yml"
+      exit!
+    end
+
+    events.each { |event| @events[event] = instance_eval(File.read("events/\#{event.downcase.capitalize}.rb")) }
+    @events.each { |event| event[1].activate(bot) }
+  end
+
+  class << self
+    attr_reader :events
+  end
+end

data/lib/ezdrb/templates/SingleCommand.erb

@@ -0,0 +1,11 @@
+class <%= command_name.capitalize %>
+
+  def activate(bot)
+    bot.command :<%= command_name %> do |event|
+      # code goes here
+    end
+  end
+
+end
+
+<%= command_name.capitalize %>.new

data/lib/ezdrb/templates/SingleEvent.erb

@@ -0,0 +1,11 @@
+class <%= event.capitalize %>
+
+  def activate(bot)
+    bot.<%= event %> do |event|
+      # code goes here
+    end
+  end
+
+end
+
+<%= event.capitalize %>.new

data/lib/ezdrb/version.rb

@@ -1,3 +1,3 @@
 module Ezdrb
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.1.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezdrb
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - monocrystal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-29 00:00:00.000000000 Z
+date: 2018-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,16 +42,30 @@ dependencies:
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: discordrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
 description: A tool that helps you write Discord bots faster (Discordrb-only)
 email:
 - askeeydev@gmail.com
@@ -74,6 +88,13 @@ files:
 - ezdrb.gemspec
 - lib/ezdrb.rb
 - lib/ezdrb/cli.rb
+- lib/ezdrb/templates/Attributes.erb
+- lib/ezdrb/templates/BotRun.erb
+- lib/ezdrb/templates/BotYml.erb
+- lib/ezdrb/templates/Commands.erb
+- lib/ezdrb/templates/Events.erb
+- lib/ezdrb/templates/SingleCommand.erb
+- lib/ezdrb/templates/SingleEvent.erb
 - lib/ezdrb/version.rb
 homepage: ''
 licenses: