matrix_sdk 2.5.0 → 2.8.0

data/lib/matrix_sdk/util/extensions.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'pp'
+
 unless Object.respond_to? :yield_self
   class Object
     def yield_self
@@ -51,21 +53,29 @@ module MatrixSdk
 
     def ignore_inspect(*symbols)
       class_eval %*
-        def inspect
-          reentrant = caller_locations.any? { |l| l.absolute_path == __FILE__ && l.label == 'inspect' }
-          "\\\#<\#{self.class} \#{instance_variables
+        include PP::ObjectMixin
+
+        def pretty_print_instance_variables
+          instance_variables
             .reject { |f| %i[#{symbols.map { |s| "@#{s}" }.join ' '}].include? f }
-            .map { |f| "\#{f}=\#{reentrant ? instance_variable_get(f) : instance_variable_get(f).inspect}" }.join " " }}>"
+            .sort
         end
-      *, __FILE__, __LINE__ - 7
+
+        def pretty_print(pp)
+          pp.pp(self)
+        end
+
+        alias inspect pretty_print_inspect
+      *, __FILE__, __LINE__ - 14
     end
   end
 
   module Logging
     def logger
       return MatrixSdk.logger if MatrixSdk.global_logger?
+      return @logger if instance_variable_defined?(:@logger) && @logger
 
-      @logger ||= ::Logging.logger[self]
+      ::Logging.logger[self]
     end
 
     def logger=(logger)

data/lib/matrix_sdk/util/state_event_cache.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module MatrixSdk::Util
+  class StateEventCache
+    extend MatrixSdk::Extensions
+    extend MatrixSdk::Util::Tinycache
+    include Enumerable
+
+    attr_reader :room
+
+    attr_accessor :cache_time
+
+    ignore_inspect :client, :room, :tinycache_adapter
+
+    def initialize(room, cache_time: 30 * 60, **_params)
+      raise ArgumentError, 'Must be given a Room instance' unless room.is_a? MatrixSdk::Room
+
+      @room = room
+      @cache_time = cache_time
+    end
+
+    def client
+      @room.client
+    end
+
+    def reload!
+      tinycache_adapter.clear
+    end
+
+    def keys
+      tinycache_adapter.send(:cache).keys.map do |type|
+        real_type = type.split('|').first
+        state_key = type.split('|').last
+        state_key = nil if state_key == real_type
+
+        [real_type, state_key]
+      end
+    end
+
+    def values
+      keys.map { |key| tinycache_adapter.read(key) }
+    end
+
+    def size
+      keys.count
+    end
+
+    def key?(type, key = nil)
+      keys.key?("#{type}#{key ? "|#{key}" : ''}")
+    end
+
+    def expire(type, key = nil)
+      tinycache_adapter.expire("#{type}#{key ? "|#{key}" : ''}")
+    end
+
+    def each(live: false)
+      return to_enum(__method__, live: live) { keys.count } unless block_given?
+
+      keys.each do |type|
+        real_type = type.split('|').first
+        state_key = type.split('|').last
+        state_key = nil if state_key == real_type
+
+        v = live ? self[real_type, key: state_key] : tinycache_adapter.read(type)
+        # hash = v.hash
+        yield [real_type, state_key], v
+        # self[key] = v if hash != v.hash
+      end
+    end
+
+    def delete(type, key = nil)
+      type = type.to_s unless type.is_a? String
+      client.api.set_room_state(room.id, type, {}, **{ state_key: key }.compact)
+      tinycache_adapter.delete("#{type}#{key ? "|#{key}" : ''}")
+    end
+
+    def [](type, key = nil)
+      type = type.to_s unless type.is_a? String
+      tinycache_adapter.fetch("#{type}#{key ? "|#{key}" : ''}", expires_in: @cache_time) do
+        client.api.get_room_state(room.id, type, **{ key: key }.compact)
+      rescue MatrixSdk::MatrixNotFoundError
+        {}
+      end
+    end
+
+    def []=(type, key = nil, value) # rubocop:disable Style/OptionalArguments Not possible to put optional last
+      type = type.to_s unless type.is_a? String
+      client.api.set_room_state(room.id, type, value, **{ state_key: key }.compact)
+      tinycache_adapter.write("#{type}#{key ? "|#{key}" : ''}", value)
+    end
+  end
+end

data/lib/matrix_sdk/util/tinycache.rb

@@ -75,13 +75,19 @@ module MatrixSdk::Util
 
         define_method(method_names[:with_cache]) do |*args|
           tinycache_adapter.fetch(__send__(method_names[:cache_key], *args), expires_in: expires_in) do
-            __send__(method_names[:without_cache], *args)
+            named = args.delete_at(-1) if args.last.is_a? Hash
+            named ||= {}
+
+            __send__(method_names[:without_cache], *args, **named)
           end
         end
 
         define_method(method_names[:without_cache]) do |*args|
           orig = method(method_name).super_method
-          orig.call(*args)
+          named = args.delete_at(-1) if args.last.is_a? Hash
+          named ||= {}
+
+          orig.call(*args, **named)
         end
 
         define_method(method_names[:clear_cache]) do |*args|

data/lib/matrix_sdk/util/tinycache_adapter.rb

@@ -2,8 +2,12 @@
 
 module MatrixSdk::Util
   class TinycacheAdapter
+    extend MatrixSdk::Extensions
+
     attr_accessor :config, :client
 
+    ignore_inspect :client
+
     def initialize
       @config = {}
 
@@ -54,12 +58,18 @@ module MatrixSdk::Util
       true
     end
 
+    def expire(key)
+      return unless exist? key
+
+      cache[key].expires_at = Time.at(0)
+    end
+
     def clear
       @cache = {}
     end
 
     def cleanup
-      @cache.delete_if { |_, v| v.expired? }
+      @cache.select { |_, v| v.expired? }.each { |_, v| v.value = nil }
     end
 
     private

data/lib/matrix_sdk/util/uri.rb

@@ -7,14 +7,20 @@ module URI
   class MXC < Generic
     def full_path
       select(:host, :port, :path, :query, :fragment)
-        .reject(&:nil?)
+        .compact
         .join
     end
   end
 
-  @@schemes['MXC'] = MXC
+  # TODO: Use +register_scheme+ on Ruby >=3.1 and fall back to old behavior
+  # for older Rubies. May be removed at EOL of Ruby 3.0.
+  if respond_to? :register_scheme
+    register_scheme 'MXC', MXC
+  else
+    @@schemes['MXC'] = MXC
+  end
 
-  unless @@schemes.key? 'MATRIX'
+  unless scheme_list.key? 'MATRIX'
     # A matrix: URI according to MSC2312
     class MATRIX < Generic
       attr_reader :authority, :action, :mxid, :mxid2, :via
@@ -84,6 +90,12 @@ module URI
       end
     end
 
-    @@schemes['MATRIX'] = MATRIX
+    # TODO: Use +register_scheme+ on Ruby >=3.1 and fall back to old behavior
+    # for older Rubies. May be removed at EOL of Ruby 3.0.
+    if respond_to? :register_scheme
+      register_scheme 'MATRIX', MATRIX
+    else
+      @@schemes['MATRIX'] = MATRIX
+    end
   end
 end

data/lib/matrix_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MatrixSdk
-  VERSION = '2.5.0'
+  VERSION = '2.8.0'
 end

data/lib/matrix_sdk.rb

@@ -10,7 +10,7 @@ autoload :Logging, 'logging'
 
 module MatrixSdk
   autoload :Api, 'matrix_sdk/api'
-  autoload :ApplicationService, 'matrix_sdk/application_service'
+  # autoload :ApplicationService, 'matrix_sdk/application_service'
   autoload :Client, 'matrix_sdk/client'
   autoload :MXID, 'matrix_sdk/mxid'
   autoload :Response, 'matrix_sdk/response'
@@ -28,11 +28,17 @@ module MatrixSdk
   autoload :MatrixTimeoutError, 'matrix_sdk/errors'
   autoload :MatrixUnexpectedResponseError, 'matrix_sdk/errors'
 
+  module Bot
+    autoload :Base, 'matrix_sdk/bot/base'
+  end
+
   module Rooms
     autoload :Space, 'matrix_sdk/rooms/space'
   end
 
   module Util
+    autoload :AccountDataCache, 'matrix_sdk/util/account_data_cache'
+    autoload :StateEventCache, 'matrix_sdk/util/state_event_cache'
     autoload :Tinycache, 'matrix_sdk/util/tinycache'
     autoload :TinycacheAdapter, 'matrix_sdk/util/tinycache_adapter'
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matrix_sdk
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Alexander Olofsson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -95,6 +95,9 @@ files:
 - README.md
 - lib/matrix_sdk.rb
 - lib/matrix_sdk/api.rb
+- lib/matrix_sdk/bot.rb
+- lib/matrix_sdk/bot/base.rb
+- lib/matrix_sdk/bot/main.rb
 - lib/matrix_sdk/client.rb
 - lib/matrix_sdk/errors.rb
 - lib/matrix_sdk/mxid.rb
@@ -107,8 +110,10 @@ files:
 - lib/matrix_sdk/room.rb
 - lib/matrix_sdk/rooms/space.rb
 - lib/matrix_sdk/user.rb
+- lib/matrix_sdk/util/account_data_cache.rb
 - lib/matrix_sdk/util/events.rb
 - lib/matrix_sdk/util/extensions.rb
+- lib/matrix_sdk/util/state_event_cache.rb
 - lib/matrix_sdk/util/tinycache.rb
 - lib/matrix_sdk/util/tinycache_adapter.rb
 - lib/matrix_sdk/util/uri.rb
@@ -132,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.8
 signing_key:
 specification_version: 4
 summary: SDK for applications using the Matrix protocol