discorb-view 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 630986b3d66bbcd57a098f84ca0d7baed2b7cf11100b6464e8d66b4eb6fbd08f
+  data.tar.gz: 8f830a89a62fe4a0acd98a54940ae830df2c3735061a00ba05d3408a66752a5a
+SHA512:
+  metadata.gz: 7d8259899de9b82de7ec2a58178adcdaf2097079f7feb232f39e98718aa460e27f80831862ce0726e214b0ef42e2a28b43e1f91e3eab24cabe79dcf17caa4f17
+  data.tar.gz: 373f1ec214566f874243870bb037eb8bfb28cc292dbeba7d2497d79e2068f3c0f62e572bfa21211460b83cef255e3627220cf784fd298a7620bc4020f272af00

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-09-28
+
+- Initial release

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in discorb-view.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 sevenc-nanashi
+
+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,109 @@
+# Discorb::View
+
+A wrapper of discorb's interaction. This allows you to manage buttons with callbacks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'discorb-view'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install discorb-view
+
+## Usage
+
+```rb
+client.extend Discorb::View::Extension  # Add the extension to your client
+
+class MyMenu
+  extend Discorb::View::Base
+
+  @@texts = ["A", "B"]
+
+  def initialize
+    @page = 0
+  end
+
+  button :left, "<", :primary do |interaction|  # Define a button
+    @page -= 1
+  end
+
+  button :right, ">", :primary do |interaction|
+    @page += 1
+  end
+
+  button :quit, "Quit", :danger do |interaction|
+    stop!  # Stop the view
+  end
+
+  view ->(interaction) { !((0...@@texts.length).include?(@page)) } do |result|  # Define a view that will be shown when the page is out of range
+    result.content = "Out of range: Page #{@page + 1}"
+  end
+
+  view do |result|  # Define a view that will be shown when the page is in range
+    result.content = @@texts[@page % @@texts.length]
+    result.embeds = []
+    result.components = [:left, :right, :quit]
+  end
+end
+
+class MyPager
+  extend Discorb::View::Base
+
+  @@pages = [
+    "Page 1 Content",
+    "Page 2 Content",
+    "Page 3 Content",
+    "Page 4 Content",
+  ]
+
+  def initialize
+    @page = 0
+  end
+
+  select_menu :page, [["Page 1", "1"], ["Page 2", "2"], ["Page 3", "3"], ["Page 4", "4"]], "Page" do |interaction|
+    @page = interaction.value.to_i - 1
+  end
+
+  button :quit, "Quit", :danger do |interaction|
+    stop!
+  end
+
+  view do |result|
+    result.content = @@pages[@page]
+    result.embeds = []
+    result.components = [:page, :quit]
+  end
+end
+
+client.on :message do |message|
+  next if message.author.bot?
+
+  MyMenu.start(message.channel)  if message.content.downcase == "menu"
+
+  MyPager.start(message.channel)  if message.content.downcase == "pager"
+end
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/discorb-lib/discorb-view.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "discorb/view"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/discorb-view.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/discorb/view/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "discorb-view"
+  spec.version = Discorb::View::VERSION
+  spec.authors = ["sevenc-nanashi"]
+  spec.email = ["sevenc-nanashi@sevenbot.jp"]
+
+  spec.summary = "View for Discorb"
+  spec.homepage = "https://github.com/discorb-lib/discorb-view"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/discorb-lib/discorb-view"
+  spec.metadata["changelog_uri"] = "https://github.com/discorb-lib/discorb-view/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "discorb", "~> 0.9.6"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/examples/menu.rb

@@ -0,0 +1,50 @@
+require "discorb"
+require "discorb/view"
+
+client = Discorb::Client.new
+
+client.extend Discorb::View::Extension
+
+class MyMenu
+  extend Discorb::View::Base
+
+  @@texts = ["A", "B"]
+
+  def initialize
+    @page = 0
+  end
+
+  button :left, "<", :primary do |interaction|
+    @page -= 1
+  end
+
+  button :right, ">", :primary do |interaction|
+    @page += 1
+  end
+
+  button :quit, "Quit", :danger do |interaction|
+    stop!
+  end
+
+  view ->(interaction) { !((0...@@texts.length).include?(@page)) } do |result|
+    result.content = "Out of range: Page #{@page + 1}"
+  end
+
+  view do |result|
+    result.content = @@texts[@page % @@texts.length]
+    result.embeds = []
+    result.components = [:left, :right, :quit]
+  end
+end
+
+client.once :standby do
+  puts "Ready!"
+end
+
+client.on :message do |message|
+  next unless message.content == "menu"
+
+  MyMenu.start(message.channel)
+end
+
+client.run ENV["DISCORD_BOT_TOKEN"]

data/examples/pager.rb

@@ -0,0 +1,47 @@
+require "discorb"
+require "discorb/view"
+
+client = Discorb::Client.new
+
+client.extend Discorb::View::Extension
+
+class MyPager
+  extend Discorb::View::Base
+
+  @@pages = [
+    "Page 1 Content",
+    "Page 2 Content",
+    "Page 3 Content",
+    "Page 4 Content",
+  ]
+
+  def initialize
+    @page = 0
+  end
+
+  select_menu :page, [["Page 1", "1"], ["Page 2", "2"], ["Page 3", "3"], ["Page 4", "4"]], "Page" do |interaction|
+    @page = interaction.value.to_i - 1
+  end
+
+  button :quit, "Quit", :danger do |interaction|
+    stop!
+  end
+
+  view do |result|
+    result.content = @@pages[@page]
+    result.embeds = []
+    result.components = [:page, :quit]
+  end
+end
+
+client.once :standby do
+  puts "Ready!"
+end
+
+client.on :message do |message|
+  next unless message.content == "menu"
+
+  MyPager.start(message.channel)
+end
+
+client.run ENV["DISCORD_BOT_TOKEN"]

data/lib/discorb/view/extension.rb

@@ -0,0 +1,41 @@
+module Discorb::View
+  #
+  # An extension for using discorb-view.
+  # @note Client must extend this class to use discorb-view.
+  #
+  module Extension
+    attr_accessor :views
+
+    extend Discorb::Extension
+
+    event :button_click do |interaction|
+      handle_interaction(interaction)
+    end
+
+    event :select_menu_select do |interaction|
+      handle_interaction(interaction)
+    end
+
+    # @private
+    def self.extended(base)
+      base.views = {}
+    end
+
+    class << self
+      # @private
+      def handle_interaction(interaction)
+        unless view = @client.views[interaction.message.id.to_s]
+          @client.log.warn "View: No handler for #{interaction.message.id.to_s}"
+          return
+        end
+        handler = view.class.components[interaction.custom_id.to_sym]
+        @client.log.debug "View: Handling #{interaction.custom_id} in #{interaction.message.id}"
+        view.interaction = interaction
+        update = view.instance_exec(interaction, &handler.block)
+        return unless update
+        @client.log.debug "View: Updating view #{interaction.message.id}"
+        view.render
+      end
+    end
+  end
+end

data/lib/discorb/view/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Discorb
+  module View
+    # @return [String] the version of the gem
+    VERSION = "0.1.0"
+  end
+end

data/lib/discorb/view/view.rb

@@ -0,0 +1,191 @@
+require "securerandom"
+
+module Discorb::View
+  #
+  # Handler for the components.
+  #
+  class ComponentHandler < Struct.new(:object, :block)
+    #
+    # Redirects method calls to the object.
+    #
+    def method_missing(method, ...)
+      object.send(method, ...)
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      object.respond_to?(method, include_private)
+    end
+  end
+
+  #
+  # Handles the rendering of the components.
+  #
+  class ViewHandler < Struct.new(:check, :block); end
+
+  #
+  # Base class for the view.
+  # @note You should not use this class directly.
+  # @abstract
+  #
+  module Base
+    # @return [Hash{Symbol => Discorb::Component}] The components.
+    attr_accessor :components
+    # @return [Array<ViewHandler>] The view handlers.
+    attr_accessor :views
+
+    # @private
+    def self.extended(base)
+      base.prepend(Discorb::View::Base::Prepend)
+      base.components = {}
+      base.views = []
+    end
+
+    #
+    # Adds button component to the view.
+    #
+    # @param [Symbol] id The id of the button.
+    # @param [String] label The label of the button.
+    # @param [:primary, :secondary, :success, :danger] style The style of the button.
+    # @param [Discorb::Emoji, nil] emoji The emoji of the button.
+    # @yield The block to execute when the button is clicked.
+    # @yieldparam [Discorb::MessageComponentInteraction] interaction The interaction.
+    #
+    def button(id, label, style = :secondary, emoji: nil, &block)
+      raise ArgumentError, "block required" unless block_given?
+      button = Discorb::Button.new(label, style, emoji: emoji, custom_id: id)
+      @components[id] = ComponentHandler.new(button, block)
+    end
+
+    #
+    # Adds select menu component to the view.
+    #
+    # @param [Symbol] id The id of the button.
+    # @param [String] label The label of the button.
+    # @param [String, nil] placeholder The placeholder of the select menu.
+    # @param [Integer, nil] min_length The minimum length of the select menu.
+    # @param [Integer, nil] max_length The max length of the select menu.
+    # @yield The block to execute when the menu is changed.
+    # @yieldparam [Discorb::MessageComponentInteraction] interaction The interaction.
+    #
+    def select_menu(id, options, placeholder = nil, min_values: nil, max_values: nil, &block)
+      raise ArgumentError, "block required" unless block_given?
+      options.map! { |option| option.is_a?(Discorb::SelectMenu::Option) ? option : Discorb::SelectMenu::Option.new(*option) }
+      menu = Discorb::SelectMenu.new(id, options, placeholder: placeholder, min_values: min_values, max_values: max_values)
+      @components[id] = ComponentHandler.new(menu, block)
+    end
+
+    #
+    # Add view handler to the view.
+    #
+    # @param [Proc, nil] check The check of the view handler.
+    #   The view handler will be executed when the check returns true, or check is nil.
+    # @yield The block to execute when the view handler is executed.
+    # @yieldparam [Discorb::View::Base::Prepend::Result] result The result of the view.
+    #
+    # @note There must be one handler with no check.
+    #
+    def view(check = nil, &block)
+      raise ArgumentError, "block required" unless block_given?
+      @views.insert(0, ViewHandler.new(check, block))
+    end
+
+    #
+    # Starts the view.
+    #
+    # @param [Discorb::Messageable] channel The channel to send the message to.
+    #
+    def start(channel, ...)
+      client = channel.instance_variable_get(:@client)
+      if @views.empty?
+        raise "No views defined"
+      elsif not @views.any? { |v| v.check.nil? }
+        raise "No fallback view defined"
+      elsif @views.filter { |v| v.check.nil? }.count > 1
+        raise "Multiple fallback views defined"
+      end
+      view = new(client, channel, ...)
+      view.start
+    end
+
+    #
+    # Modules for the prepend.
+    #
+    module Prepend
+      # @return [Discorb::MessageComponentInteraction] The interaction.
+      attr_writer :interaction
+
+      #
+      # The result for rendering the view.
+      #
+      class Result < Struct.new(:content, :embeds, :components); end
+
+      # @private
+      def initialize(client, channel, ...)
+        @client = channel.instance_variable_get(:@client)
+        @channel = channel
+        @message_id = nil
+        @stopped = false
+        @result = Result.new(nil, [], [])
+        super(...)
+      end
+
+      # @private
+      def start
+        render
+        @client.views[@message_id.to_s] = self
+      end
+
+      #
+      # Stops the view.
+      #
+      # @param [Boolean] disable Whether to disable the components.
+      # @param [Boolean] delete Whether to delete the message.
+      #
+      def stop!(disable: true, delete: false)
+        @client.views.delete(@message_id.to_s)
+        if disable
+          @stopped = true
+          render
+        end
+        @channel.delete_message!(@message_id) if delete
+      end
+
+      #
+      # Renders the view.
+      #
+      def render
+        instance_exec(@result, &actual_view.block)
+        components = @result.components.map do |c|
+          case c
+          when Symbol
+            self.class.components[c]&.object or raise ArgumentError "Unknown component ID #{c}"
+          when Button
+            c
+          else
+            raise ArgumentError "Component must be a Symbol or a Button"
+          end
+        end
+        if @stopped
+          components.each do |component|
+            component.disabled = true
+          end
+        end
+        if @interaction
+          @interaction.edit(@result.content, embeds: @result.embeds, components: components).wait
+        else
+          msg = @channel.post(@result.content, embeds: @result.embeds, components: components).wait
+          @message_id = msg.id
+        end
+      end
+
+      # @private
+      def actual_view
+        view = self.class.views.filter { |v| v.check }.find { |v| instance_exec(@interaction, &v.check) }
+        if view.nil?
+          view = self.class.views.find { |v| v.check.nil? }
+        end
+        view
+      end
+    end
+  end
+end

data/lib/discorb/view.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "view/version"
+require_relative "view/view"
+require_relative "view/extension"
+
+module Discorb
+  module View
+    class Error < StandardError; end
+
+    # Your code goes here...
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: discorb-view
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sevenc-nanashi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: discorb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+description:
+email:
+- sevenc-nanashi@sevenbot.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- discorb-view.gemspec
+- examples/menu.rb
+- examples/pager.rb
+- lib/discorb/view.rb
+- lib/discorb/view/extension.rb
+- lib/discorb/view/version.rb
+- lib/discorb/view/view.rb
+homepage: https://github.com/discorb-lib/discorb-view
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/discorb-lib/discorb-view
+  source_code_uri: https://github.com/discorb-lib/discorb-view
+  changelog_uri: https://github.com/discorb-lib/discorb-view/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: View for Discorb
+test_files: []