rubirai 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 174008ec842a298001749f9dc9650708cf789be436d9bdcde347270edc14b435
-  data.tar.gz: 31d528b994fe981b958e02a3847657d4c6b60848ce9778ee6126c1068d90a410
+  metadata.gz: b91aff486d51f20061c25e988fabfb4adcf34b765f30bdd6f118858faafcb693
+  data.tar.gz: 2508fa6974b69f487098972e89ba2fe04f32fe566f5e04a14aadb595653cabcd
 SHA512:
-  metadata.gz: a512e0d593a4d59d6988deeab66f671529bd2651e4fecc984c92f6b7da26317b7a87f1259a348fc38dad13bee02600457e5e832f2b947fded5f2439417c3d1d8
-  data.tar.gz: '0976747106fbe368257515a5f3164fc190b3f751631fdef68f059655ac624ee7b3d55898b543adaf404e1fa30ae7f4c20a7bfe6283ef00cc8bdf80fe2592c09c'
+  metadata.gz: 9676cbb324b9aed4abaca4d69f1f58791d0edb11434cb90ebc0bb9f1677d18c61d82d3b0709c9b0fca0eda176e2bd924dcaf5bb894f992ed77b27d06385f818a
+  data.tar.gz: 92e5e0e168ec5b6834beb81d1398c64e5521b15adc869b95f12ea8e3e54e65f9f33f41e6e789377c710ad695357890da2b71a8ccc110327f956dd7195a177c87

data/.github/workflows/docs.yml

@@ -5,7 +5,7 @@ on:
     branches: [ master ]
 
 jobs:
-  test:
+  gendoc:
     runs-on: ubuntu-latest
     strategy:
       matrix:

data/.github/workflows/pull_request.yml

@@ -9,7 +9,9 @@ name: Pull Request
 
 on:
   pull_request:
-    branches: [ master ]
+    branches:
+      - master
+      - dev
 
 jobs:
   test:

data/README.md

@@ -11,6 +11,18 @@ A light-weight Mirai QQ bot http interface lib for Ruby.
 
 [中文][wiki] | [Rubydocs][rubydocs]
 
+## Description
+
+This library is designed specifically for integration with [mirai-api-http].
+[Mirai][mirai] is a QQ bot framework. The relationship is like this:
+
+```
+mirai <-jvm-> mirai-console <-plugin-> mirai-api-http <-http-> rubirai
+```
+
+[mirai-api-http]: https://github.com/project-mirai/mirai-api-http
+[mirai]: https://github.com/mamoe/mirai
+
 ## Usage
 
 First, download the package using `gem`. In your `Gemfile`, add

data/lib/rubirai/messages/interpolation.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'rubirai/utils'
+
+module Rubirai
+  # @!attribute [r] has_interpolation
+  #   @return [Boolean] if this message chain has interpolation called by {#interpolated_str}
+  class MessageChain
+    attr_reader :has_interpolation
+
+    # Convert the message chain to an interpolated string.
+    #
+    # @return [String]
+    def interpolated_str
+      return @interpolated_str if @has_interpolation
+      @interpolated_str = _gen_interp_str
+      @has_interpolation = true
+      @interpolated_str
+    end
+
+    # Get the interpolated object by given id
+    #
+    # @param obj_id [String] the object id
+    # @return [Message, nil] the message. `nil` if `obj_id` is malformed or not found.
+    def get_object(obj_id)
+      _get_object(obj_id)
+    end
+
+    # Get a new chain from interpolated string generated from the original message chain.
+    # The given interpolated string can be a substring of original one so that elements
+    # can be extracted easily.
+    #
+    # @param str [String] the interpolated string
+    # @return [MessageChain] the message chain constructed
+    def chain_from_interpolated(str)
+      _interpolate_with_objects(str)
+    end
+
+    private
+
+    OBJ_INTERP_CHAR = '%'
+    OBJ_INTERP_LEN = 6
+
+    def _gen_interp_str
+      result = +''
+      @messages.each do |msg|
+        result << case msg
+                  when PlainMessage
+                    _transform_plain_txt(msg.text)
+                  else
+                    _transform_object(msg)
+                  end
+      end
+      result
+    end
+
+    def _transform_plain_txt(str)
+      str.gsub(OBJ_INTERP_CHAR, OBJ_INTERP_CHAR * 2)
+    end
+
+    def _transform_object(obj)
+      obj_id = Utils.random_str(OBJ_INTERP_LEN)
+      obj_id = Utils.random_str(OBJ_INTERP_LEN) while @ipl_objs_map.include?(obj_id)
+      @ipl_objs_map[obj_id] = obj
+      "#{OBJ_INTERP_CHAR}#{obj_id}#{OBJ_INTERP_CHAR}"
+    end
+
+    def _get_object(obj_id)
+      return nil if obj_id.length != OBJ_INTERP_LEN && obj_id.length != (OBJ_INTERP_LEN + 2)
+      return @ipl_objs_map[obj_id] if obj_id.length == OBJ_INTERP_LEN
+      return nil if obj_id[0] != OBJ_INTERP_CHAR || obj_id[-1] != OBJ_INTERP_CHAR
+
+      @ipl_objs_map[obj_id[1...-1]]
+    end
+
+    # @private
+    # @param str [String]
+    def _interpolate_with_objects(str)
+      sb = +''
+      result = MessageChain.new(bot)
+      i = 0
+      while i < str.length
+        if i == str.length - 1
+          sb << str[i]
+          break
+        end
+
+        if str[i] != OBJ_INTERP_CHAR
+          sb << str[i]
+          i += 1
+          next
+        end
+
+        if str[i + 1] == OBJ_INTERP_CHAR
+          sb << OBJ_INTERP_CHAR
+          i += 1
+        else
+          result.append PlainMessage.from(text: sb) unless sb.empty?
+          sb = str[i...i + OBJ_INTERP_LEN + 2]
+          obj = _get_object(sb)
+          i += OBJ_INTERP_LEN + 1
+          unless obj.nil?
+            result.append obj
+            sb = +''
+          end
+        end
+
+        i += 1
+      end
+
+      result.append PlainMessage.from(text: sb) unless sb.nil? || sb.empty?
+      result
+    end
+  end
+end

data/lib/rubirai/messages/message_chain.rb

@@ -5,19 +5,20 @@ require 'rubirai/messages/message'
 
 module Rubirai
   # Message chain
+  #
+  # @!attribute [r] bot
+  #   @return [Bot] the bot object
+  # @!attribute [r] id
+  #   @return [Integer, nil] the message id, may be `nil`
+  # @!attribute [r] raw
+  #   @return [Hash{String => Object}, nil] the raw message chain, may be `nil`
+  # @!attribute [r] send_time
+  #   @return [Integer, nil] the send time of the message chain, may be `nil`
+  # @!attribute [r] messages
+  #   @return [Array<Message>] the raw message array
   class MessageChain
     include Enumerable
 
-    # @!attribute [r] bot
-    #   @return [Bot] the bot object
-    # @!attribute [r] id
-    #   @return [Integer, nil] the message id, may be `nil`
-    # @!attribute [r] raw
-    #   @return [Hash{String => Object}, nil] the raw message chain, may be `nil`
-    # @!attribute [r] send_time
-    #   @return [Integer, nil] the send time of the message chain, may be `nil`
-    # @!attribute [r] messages
-    #   @return [Array<Message>] the raw message array
     attr_reader :bot, :id, :raw, :send_time, :messages
 
     # Makes a message chain from a list of messages
@@ -92,6 +93,9 @@ module Rubirai
     def initialize(bot = nil, source = nil)
       @bot = bot
       @messages = []
+      @has_interpolation = false
+      @interpolated_str = nil
+      @ipl_objs_map = {}
       @raw = source
       return unless source
       raise(MiraiError, 'source is not array') unless source.is_a? Array
@@ -139,3 +143,5 @@ module Rubirai
     MessageChain.make(*messages, bot: bot)
   end
 end
+
+require 'rubirai/messages/interpolation'

data/lib/rubirai/utils.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'securerandom'
+
 # @private
 class Hash
   def stringify_keys!
@@ -60,3 +62,11 @@ class Object
     end
   end
 end
+
+module Rubirai
+  module Utils
+    def self.random_str(len)
+      SecureRandom.alphanumeric len
+    end
+  end
+end

data/lib/rubirai/version.rb

@@ -2,7 +2,7 @@
 
 module Rubirai
   # Rubirai version
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 
   # mirai-api-http version
   MIRAI_API_VERSION = '1.10.0'

data/spec/messages/interpolation_spec.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+describe Rubirai::MessageChain do
+  before do
+    hash = {
+      "type": 'Quote',
+      "id": 123456,
+      "groupId": 123456789,
+      "senderId": 987654321,
+      "targetId": 9876543210,
+      "origin": [
+        { "type": 'Plain', text: 'text' }.stringify_keys
+      ]
+    }.stringify_keys
+    @obj = Rubirai::AtMessage.from(target: 114514)
+    @chain = Rubirai::MessageChain.make(
+      'hi%', 2, @obj, 3, 'great %%,', :good, hash
+    )
+    @expect_pattern = /^hi%%2%[a-zA-Z0-9]{6}%3great %%%%,good%[a-zA-Z0-9]{6}%$/
+  end
+
+  after do
+  end
+
+  it 'should convert message chains to strings correctly' do
+    expect(@chain.has_interpolation).to be_falsey
+
+    str = @chain.interpolated_str
+    expect(@chain.has_interpolation).to be_truthy
+    objs_map = @chain.instance_variable_get('@ipl_objs_map')
+    expect(objs_map.length).to be(2)
+    objs_map.each_key do |k|
+      expect(str.include?(k)).to be_truthy
+    end
+    expect(@expect_pattern.match?(str)).to be_truthy
+    expect(@chain.interpolated_str).to eq(str)
+  end
+
+  it 'should get back the original object' do
+    str = @chain.interpolated_str
+    idx = 5
+    obj = @chain.get_object(str[idx...idx + 8])
+    expect(obj).to eq(@obj)
+    obj = @chain.get_object(str[idx + 1...idx + 7])
+    expect(obj).to eq(@obj)
+    expect(@chain.get_object(str[idx + 2...idx + 8])).to be_nil
+  end
+
+  it 'should construct new message chain for interpolated strings' do
+    str = @chain.interpolated_str[5...5 + 8 + 3]
+    chain = @chain.chain_from_interpolated(str)
+    expect(chain.length).to eq(2)
+    expect(chain[0]).to eq(@obj)
+    expect(chain[1]).to be_a(Rubirai::PlainMessage)
+    expect(chain[1].text).to eq('3gr')
+
+    chain = @chain.chain_from_interpolated(@chain.interpolated_str)
+    expect(chain.length).to eq(@chain.length)
+    expect(chain[0].text).to eq('hi%2')
+    expect(chain[1]).to eq(@obj)
+    expect(chain[2].text).to eq('3great %%,good')
+    expect(chain[3]).to be_a(Rubirai::QuoteMessage)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubirai
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Rebuild
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-03 00:00:00.000000000 Z
+date: 2021-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -73,6 +73,7 @@ files:
 - lib/rubirai/listing.rb
 - lib/rubirai/management.rb
 - lib/rubirai/message.rb
+- lib/rubirai/messages/interpolation.rb
 - lib/rubirai/messages/message.rb
 - lib/rubirai/messages/message_chain.rb
 - lib/rubirai/multipart.rb
@@ -90,6 +91,7 @@ files:
 - spec/error_spec.rb
 - spec/events/event_spec.rb
 - spec/message_spec.rb
+- spec/messages/interpolation_spec.rb
 - spec/messages/message_chain_spec.rb
 - spec/messages/message_spec.rb
 - spec/plugin_info_spec.rb