dispander.rb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3e930967666092faf411622028c20fa7d31796cd0fe5e0eed7995fd82c79d30
-  data.tar.gz: b34675bc0a76a89e04efec3a7dbb8ec25372b5797b7ac5e1ee00255a22bbe1c7
+  metadata.gz: 72ece3741f679c4e18bfe11980bf92baa46d74fa86269ed8e93facabac2f993c
+  data.tar.gz: c6da4e5800057ef09807e4a878a4b6785ed13cfaa27e470149265617722a2390
 SHA512:
-  metadata.gz: d964954609afb5804c4adcb7f0ad25513ebc9329d81de7dab8ed2e62d43b0db96c0b75dd8f6748469b48fb56cd45d5c27f515907b4ac23eb306410ee3165e663
-  data.tar.gz: dfea449df14d2779df00890b8bfa60d288149130f00bcc2df34d35da97818ab01b245659ebc5a50c6a4e927118bd05311c4d79bf0e8d05580db9a5634cf6e6c1
+  metadata.gz: b72de3c9775d139c533cb037caa0fa900eaf85bdd7815151b92d4add249c96b04c5469a1401b6861563f5018a0ffe778100aabe5b36bbbff1f1088031586a1eb
+  data.tar.gz: 02fdeac6d1c1fff4d728a19d37368955cb998ee3199b910c9d1867bc7a951ee91f7dd1eee44e6834e0a2f2de718e7e655d11d6ca8e6f8be3d857178b36e2b679

data/.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+Gemfile.lock

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 sevenc-nanashi
+Copyright (c) 2021 Discord Bot Portal JP
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.en.md

@@ -0,0 +1,80 @@
+# dispander.rb
+
+An extension that adds message expanding feature for discorb bot.
+![image](https://user-images.githubusercontent.com/59691627/131650571-ec50bf35-c971-4aeb-9a58-8fbf9b3e759b.png)
+
+Ruby version of [DiscordBotPortalJP/dispander](https://github.com/DiscordBotPortalJP/dispander).
+
+## Install
+
+Add this to Gemfile...
+
+```ruby
+gem 'dispander'
+```
+
+And run this:
+
+    $ bundle install
+
+Or...
+
+    $ gem install dispander
+
+## Usage
+
+### Load as Extension
+
+```ruby
+require "discorb"
+require "discorb"
+require "dispander"
+
+client = Discorb::Client.new
+
+client.once :standby do
+  puts "Logged in as #{client.user}"
+end
+
+client.load_extension(Dispander::Core)
+
+client.run ENV["DISCORD_BOT_TOKEN"]
+```
+
+### Expand Manually
+
+`Dispander::Core#dispand` to expand, `Dispander::Core#delete_message` to delete message.
+
+```ruby
+require "discorb"
+require "dispander"
+
+client = Discorb::Client.new
+
+dispander = Dispander::Core.new(client)
+
+client.on :message do |message|
+  next if message.author.bot?
+
+  dispander.dispand(message)
+end
+
+client.on :reaction_add do |event|
+  dispander.delete_message(event)
+end
+
+client.run ENV["DISCORD_BOT_TOKEN"]
+```
+
+### Change emoji of deletion
+
+Set emoji to `Dispander#delete_emoji`, or specify it in `Client#load_extension`.
+
+```ruby
+client.load_extension(Dispander::Core, delete_emoji: Discorb::UnicodeEmoji["x"])
+```
+
+
+## License
+
+Source is open under [MIT License](https://opensource.org/licenses/MIT).

data/README.md

@@ -31,22 +31,18 @@ require "dispander"
 
 client = Discorb::Client.new
 
-client.once :ready do
-  puts <<~EOS
-         ---------
-         Logged in as #{client.user}(#{client.user.id})
-         ---------
-       EOS
+client.once :standby do
+  puts "Logged in as #{client.user}"
 end
 
-client.extend(Dispander)
+client.load_extension(Dispander::Core)
 
 client.run ENV["DISCORD_BOT_TOKEN"]
 ```
 
 ### 手動で実行する
 
-`Dispander.dispand`でメッセージを展開、`Dispander.delete_message`で展開したメッセージを削除できます。
+`Dispander::Core#dispand`でメッセージを展開、`Dispander::Core#delete_message`で展開したメッセージを削除できます。
 
 ```ruby
 require "discorb"
@@ -54,14 +50,16 @@ require "dispander"
 
 client = Discorb::Client.new
 
+dispander = Dispander::Core.new(client)
+
 client.on :message do |message|
   next if message.author.bot?
 
-  Dispander.dispand(message)
+  dispander.dispand(message)
 end
 
 client.on :reaction_add do |event|
-  Dispander.delete_message(event)
+  dispander.delete_message(event)
 end
 
 client.run ENV["DISCORD_BOT_TOKEN"]
@@ -69,12 +67,10 @@ client.run ENV["DISCORD_BOT_TOKEN"]
 
 ### 削除の絵文字を変更する
 
-`Dispander.delete_emoji`に絵文字を指定してください。
+`Dispander#delete_emoji`に絵文字を指定するか、`Client#load_extension`に引数として追加してください。
 
 ```ruby
-Dispander.delete_emoji = Discorb::UnicodeEmoji.new("x")
-
-client.extend(Dispander)
+client.load_extension(Dispander::Core, delete_emoji: Discorb::UnicodeEmoji["x"])
 ```
 
 

data/dispander.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "discorb", "~> 0.2.4"
+  spec.add_dependency "discorb", "~> 0.10.1"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/dispander/extension.rb

@@ -1,20 +1,24 @@
 require "discorb"
 
 module Dispander
-  extend Discorb::Extension
-  DISCORD_URL_PATTERN = /(?!<)https:\/\/(ptb.|canary.)?discord(app)?.com\/channels\/(?<guild>[0-9]{18,})\/(?<channel>[0-9]{18,})\/(?<message>[0-9]{18,})(?!>)/
+  class Core < Discorb::Extension
+    @@discord_url_pattern = /(?!<)https:\/\/(ptb.|canary.)?discord(app)?.com\/channels\/(?<guild>[0-9]{18,})\/(?<channel>[0-9]{18,})\/(?<message>[0-9]{18,})(?!>)/
 
-  event :message do |message|
-    next if message.author.bot?
+    def initialize(client, delete_emoji: Discorb::UnicodeEmoji["wastebasket"])
+      @delete_emoji = delete_emoji
+      super(client)
+    end
 
-    Dispander.dispand(message)
-  end
+    event :message do |message|
+      next if message.author.bot?
 
-  event :reaction_add do |event|
-    Dispander.delete_message(event)
-  end
+      dispand(message)
+    end
+
+    event :reaction_add do |event|
+      delete_message(event)
+    end
 
-  class << self
     # @return [Discorb::Emoji] 削除リアクションとして使う絵文字。
     attr_accessor :delete_emoji
 
@@ -27,7 +31,7 @@ module Dispander
     #
     def dispand(base_message)
       all_sent_messages = []
-      base_message.content.scan(DISCORD_URL_PATTERN).each do |match|
+      base_message.content.scan(@@discord_url_pattern).each do |match|
         guild_id, channel_id, message_id = *match
         next unless base_message.guild.id == guild_id
 
@@ -50,7 +54,7 @@ module Dispander
           embed.url = "http://a.io/#{base_message.author.id}-#{message.author.id}-#{sent_messages.map(&:id).join(",")}"
           first_embeds = sent_messages[0].embeds
           first_embeds[0] = embed
-          sent_messages[0].add_reaction(@delete_emoji || Discorb::UnicodeEmoji["wastebasket"])
+          sent_messages[0].add_reaction(@delete_emoji)
           sent_messages[0].edit(embeds: first_embeds).wait
           all_sent_messages += sent_messages
         end
@@ -102,7 +106,7 @@ module Dispander
     # @param [Discorb::Gateway::ReactionEvent] event リアクションのイベント。
     #
     def delete_message(event)
-      return unless event.emoji != (@delete_emoji || Discorb::UnicodeEmoji["wastebasket"])
+      return unless event.emoji == @delete_emoji
       return if event.user_id == @client.user.id
 
       message = event.fetch_message.wait

data/lib/dispander/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dispander
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/samplebot.rb

@@ -3,14 +3,10 @@ require "dispander"
 
 client = Discorb::Client.new
 
-client.once :ready do
-  puts <<~EOS
-         ---------
-         Logged in as #{client.user}(#{client.user.id})
-         ---------
-       EOS
+client.once :standby do
+  puts "Logged in as #{client.user}"
 end
 
-client.extend(Dispander)
+client.load_extension(Dispander::Core)
 
 client.run ENV["DISCORD_BOT_TOKEN"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dispander.rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - sevenc-nanashi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-01 00:00:00.000000000 Z
+date: 2021-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: discorb
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.10.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.10.1
 description:
 email:
 - sevenc-nanashi@sevenbot.jp
@@ -33,8 +33,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
+- README.en.md
 - README.md
 - Rakefile
 - bin/console

data/Gemfile.lock

@@ -1,62 +0,0 @@
-PATH
-  remote: .
-  specs:
-    dispander.rb (0.1.0)
-      discorb (~> 0.2.4)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    async (1.30.1)
-      console (~> 1.10)
-      nio4r (~> 2.3)
-      timers (~> 4.1)
-    async-http (0.56.5)
-      async (>= 1.25)
-      async-io (>= 1.28)
-      async-pool (>= 0.2)
-      protocol-http (~> 0.22.0)
-      protocol-http1 (~> 0.14.0)
-      protocol-http2 (~> 0.14.0)
-    async-io (1.32.2)
-      async
-    async-pool (0.3.8)
-      async (>= 1.25)
-    async-websocket (0.19.0)
-      async-http (~> 0.54)
-      async-io (~> 1.23)
-      protocol-websocket (~> 0.7.0)
-    console (1.13.1)
-      fiber-local
-    discorb (0.2.4)
-      async
-      async-http
-      async-websocket
-      mime-types (~> 3.3)
-    fiber-local (1.0.0)
-    mime-types (3.3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0704)
-    nio4r (2.5.8)
-    protocol-hpack (1.4.2)
-    protocol-http (0.22.5)
-    protocol-http1 (0.14.2)
-      protocol-http (~> 0.22)
-    protocol-http2 (0.14.2)
-      protocol-hpack (~> 1.4)
-      protocol-http (~> 0.18)
-    protocol-websocket (0.7.5)
-      protocol-http (~> 0.2)
-      protocol-http1 (~> 0.2)
-    rake (13.0.6)
-    timers (4.3.3)
-
-PLATFORMS
-  x86-mingw32
-
-DEPENDENCIES
-  dispander.rb!
-  rake (~> 13.0)
-
-BUNDLED WITH
-   2.2.22