fusuma 3.9.0 → 3.10.0

data/lib/fusuma/plugin/events/event.rb

@@ -10,11 +10,13 @@ module Fusuma
       # Event format
       class Event < Base
         attr_reader :time
-        attr_accessor :tag, :record
+        attr_accessor :tag #: String
+        attr_accessor :record #: Records::Record
 
         # @param time [Time]
         # @param tag [Tag]
         # @param record [String, Record]
+        #: (tag: String, record: String | Fusuma::Plugin::Events::Records::Record, ?time: Time | nil) -> void
         def initialize(tag:, record:, time: Time.now)
           super()
           @time = time
@@ -30,8 +32,9 @@ module Fusuma
           end
         end
 
+        #: () -> String
         def inspect
-          "tag: #{tag}, record: #{record}"
+          "tag: #{@tag}, record: #{@record}"
         end
       end
     end

data/lib/fusuma/plugin/events/records/gesture_record.rb

@@ -22,6 +22,7 @@ module Fusuma
           # @param gesture [String]
           # @param finger [String, Integer]
           # @param delta [Delta, NilClass]
+          #: (status: String, gesture: String, finger: Integer | String, delta: Fusuma::Plugin::Events::Records::GestureRecord::Delta | nil) -> void
           def initialize(status:, gesture:, finger:, delta:)
             super()
             @status = status
@@ -30,6 +31,7 @@ module Fusuma
             @delta = delta
           end
 
+          #: () -> String
           def to_s
             "#{@gesture}, Finger: #{@finger}, Status: #{@status}"
           end

data/lib/fusuma/plugin/events/records/index_record.rb

@@ -14,6 +14,7 @@ module Fusuma
           # @param [Config::Index] index
           # @param [Symbol] position [:prefix, :body, :surfix]
           # @param [Symbol] trigger [:oneshot, :repeat]
+          #: (index: Fusuma::Config::Index, ?position: Symbol, ?trigger: Symbol, ?args: Hash[untyped, untyped]) -> void
           def initialize(index:, position: :body, trigger: :oneshot, args: {})
             super()
             @index = index
@@ -26,6 +27,7 @@ module Fusuma
             "#{@index}, #{@position}, #{@trigger}, #{@args}"
           end
 
+          #: () -> Symbol
           def type
             :index
           end

data/lib/fusuma/plugin/events/records/record.rb

@@ -10,6 +10,7 @@ module Fusuma
         # @abstract Subclass and override {#type} to implement
         class Record < Base
           # @return [Symbol]
+          #: () -> nil
           def type
             raise NotImplementedError, "override #type"
           end

data/lib/fusuma/plugin/events/records/text_record.rb

@@ -9,16 +9,19 @@ module Fusuma
         # Default Record
         class TextRecord < Record
           # @param text [String]
+          #: (String) -> void
           def initialize(text)
             super()
             @text = text
           end
 
+          #: () -> Symbol
           def type
             :text
           end
 
           # @return [String]
+          #: () -> String
           def to_s
             @text
           end

data/lib/fusuma/plugin/executors/command_executor.rb

@@ -13,6 +13,7 @@ module Fusuma
           [:command]
         end
 
+        #: (Fusuma::Plugin::Events::Event) -> void
         def execute(event)
           command = search_command(event)
 
@@ -26,9 +27,10 @@ module Fusuma
           pid = Process.spawn(additional_env, command.to_s)
           Process.detach(pid)
         rescue SystemCallError => e
-          MultiLogger.error("#{event.record.index.keys}": e.message.to_s)
+          MultiLogger.error("#{event.record.index.keys}: #{e.message}")
         end
 
+        #: (Fusuma::Plugin::Events::Event) -> (String | bool)
         def executable?(event)
           event.tag.end_with?("_detector") &&
             event.record.type == :index &&
@@ -37,6 +39,7 @@ module Fusuma
 
         # @param event [Event]
         # @return [String]
+        #: (Fusuma::Plugin::Events::Event) -> String
         def search_command(event)
           command_index = Config::Index.new([*event.record.index.keys, :command])
           Config.instance.search(command_index)
@@ -44,6 +47,7 @@ module Fusuma
 
         # @param event [Event]
         # @return [Float]
+        #: (Fusuma::Plugin::Events::Event) -> Float
         def args_accel(event)
           accel_index = Config::Index.new([*event.record.index.keys, :accel])
           (Config.instance.search(accel_index) || 1).to_f

data/lib/fusuma/plugin/executors/executor.rb

@@ -13,6 +13,7 @@ module Fusuma
 
         # Executor parameter on config.yml
         # @return [Array<Symbol>]
+        #: () -> nil
         def execute_keys
           # [name.split('Executors::').last.underscore.gsub('_executor', '').to_sym]
           raise NotImplementedError, "override #{self.class.name}##{__method__}"
@@ -21,12 +22,14 @@ module Fusuma
         # check executable
         # @param _event [Events::Event]
         # @return [TrueClass, FalseClass]
+        #: (String) -> nil
         def executable?(_event)
           raise NotImplementedError, "override #{self.class.name}##{__method__}"
         end
 
         # @param event [Events::Event]
         # @return [TrueClass, FalseClass]
+        #: (Fusuma::Plugin::Events::Event) -> bool
         def enough_interval?(event)
           return true if event.record.index.keys.any? { |key| key.symbol == :end }
 
@@ -35,10 +38,12 @@ module Fusuma
           true
         end
 
+        #: (Fusuma::Plugin::Events::Event) -> Time
         def update_interval(event)
           @wait_until = event.time + interval(event).to_f
         end
 
+        #: (Fusuma::Plugin::Events::Event) -> Float
         def interval(event)
           @interval_time ||= {}
           index = event.record.index
@@ -57,6 +62,7 @@ module Fusuma
         # execute something
         # @param _event [Event]
         # @return [nil]
+        #: (String) -> nil
         def execute(_event)
           raise NotImplementedError, "override #{self.class.name}##{__method__}"
         end

data/lib/fusuma/plugin/filters/filter.rb

@@ -11,6 +11,7 @@ module Fusuma
         # @param event [Event]
         # @return [Event] when keeping event
         # @return [NilClass] when discarding record
+        #: (Fusuma::Plugin::Events::Event) -> Fusuma::Plugin::Events::Event?
         def filter(event)
           return event if !/#{source}/.match?(event.tag)
 
@@ -29,6 +30,7 @@ module Fusuma
 
         # Set source for tag from config.yml.
         # DEFAULT_SOURCE is defined in each Filter plugins.
+        #: () -> String
         def source
           @source ||= config_params(:source) || self.class.const_get(:DEFAULT_SOURCE)
         end

data/lib/fusuma/plugin/filters/libinput_device_filter.rb

@@ -10,6 +10,7 @@ module Fusuma
       class LibinputDeviceFilter < Filter
         DEFAULT_SOURCE = "libinput_command_input"
 
+        #: () -> Hash[Symbol, Array[Class] | Class]
         def config_param_types
           {
             source: String,
@@ -19,6 +20,7 @@ module Fusuma
 
         # @return [TrueClass] when keeping it
         # @return [FalseClass] when discarding it
+        #: (Fusuma::Plugin::Events::Records::TextRecord) -> bool
         def keep?(record)
           # NOTE: purge cache when found new device
           if record.to_s =~ /\sDEVICE_ADDED\s/ && keep_device.match_pattern?(record.to_s)
@@ -29,6 +31,7 @@ module Fusuma
           keep_device.all.map(&:id).include?(device_id)
         end
 
+        #: () -> Fusuma::Plugin::Filters::LibinputDeviceFilter::KeepDevice
         def keep_device
           @keep_device ||= begin
             from_config = Array(config_params(:keep_device_names))
@@ -36,6 +39,7 @@ module Fusuma
           end
         end
 
+        #: () -> String
         def config_param_sample
           <<~SAMPLE
             ```config.yml
@@ -50,6 +54,7 @@ module Fusuma
 
         # Select Device to keep
         class KeepDevice
+          #: (name_patterns: Array[untyped]) -> void
           def initialize(name_patterns:)
             @name_patterns = name_patterns | Array(self.class.from_option)
           end
@@ -57,12 +62,14 @@ module Fusuma
           attr_reader :name_patterns
 
           # remove cache for reloading new devices
+          #: () -> void
           def reset
             @all = nil
             Device.reset
           end
 
           # @return [Array]
+          #: () -> Array[Device]
           def all
             @all ||= if @name_patterns.empty?
               Device.available
@@ -75,6 +82,7 @@ module Fusuma
             end
           end
 
+          #: () -> nil
           def print_not_found_messages
             puts "Device is not found. Check following section on your config.yml"
             puts LibinputDeviceFilter.new.config_param_sample
@@ -82,6 +90,7 @@ module Fusuma
 
           # @return [TrueClass]
           # @return [FalseClass]
+          #: (String) -> bool
           def match_pattern?(string)
             return true if @name_patterns.empty?
 
@@ -92,6 +101,7 @@ module Fusuma
             attr_reader :from_option
 
             # TODO: remove from_option and command line options
+            #: (nil) -> void
             def from_option=(device)
               if device
                 warn <<~COMMENT

data/lib/fusuma/plugin/inputs/input.rb

@@ -9,6 +9,7 @@ module Fusuma
       # Inherite this base
       # @abstract Subclass and override {#io} to implement
       class Input < Base
+        #: (*nil) -> void
         def initialize(*args)
           super
           @tag = self.class.name.split("Inputs::").last.underscore
@@ -19,6 +20,7 @@ module Fusuma
         # Wait multiple inputs until it becomes readable
         # @param inputs [Array<Input>]
         # @return [Event]
+        #: (Array[untyped]) -> Fusuma::Plugin::Events::Event
         def self.select(inputs)
           ios = IO.select(inputs.map(&:io))
           io = ios&.first&.first
@@ -32,6 +34,7 @@ module Fusuma
         # IO#readline is blocking method
         # so input plugin must write line to pipe (include `\n`)
         # or, override read_from_io and implement your own read method
+        #: () -> String
         def read_from_io
           io.readline(chomp: true)
         rescue EOFError => e
@@ -44,11 +47,13 @@ module Fusuma
         end
 
         # @return [IO]
+        #: () -> nil
         def io
           raise NotImplementedError, "override #{self.class.name}##{__method__}"
         end
 
         # @return [Event]
+        #: (?record: String) -> Fusuma::Plugin::Events::Event
         def create_event(record: "dummy input")
           e = Events::Event.new(tag: tag, record: record)
           MultiLogger.debug(input_event: e)

data/lib/fusuma/plugin/inputs/libinput_command_input.rb

@@ -8,6 +8,7 @@ module Fusuma
     module Inputs
       # libinput commands wrapper
       class LibinputCommandInput < Input
+        #: () -> Hash[Symbol, Array[Class]]
         def config_param_types
           {
             device: [String],
@@ -23,6 +24,7 @@ module Fusuma
         end
 
         # @return [IO]
+        #: () -> StringIO
         def io
           @io ||= begin
             reader, writer = create_io
@@ -32,6 +34,7 @@ module Fusuma
         end
 
         # @return [LibinputCommand]
+        #: () -> (Fusuma::LibinputCommand)
         def command
           @command ||= LibinputCommand.new(
             libinput_options: libinput_options,
@@ -44,6 +47,7 @@ module Fusuma
         end
 
         # @return [Array]
+        #: () -> Array[String]
         def libinput_options
           device = ("--device='#{config_params(:device)}'" if config_params(:device))
           enable_tap = "--enable-tap" if config_params(:"enable-tap")
@@ -61,15 +65,18 @@ module Fusuma
           ].compact
         end
 
-        def libinput_command
+        #: () -> String?
+        def libinput_command # steep:ignore MethodBodyTypeMismatch
           config_params(:"libinput-command")
         end
 
-        def debug_events_command
+        #: () -> String?
+        def debug_events_command # steep:ignore MethodBodyTypeMismatch
           config_params(:"libinput-debug-events")
         end
 
-        def list_devices_command
+        #: () -> String?
+        def list_devices_command # steep:ignore MethodBodyTypeMismatch
           config_params(:"libinput-list-devices")
         end
 

data/lib/fusuma/plugin/inputs/timer_input.rb

@@ -17,6 +17,7 @@ module Fusuma
           }
         end
 
+        #: (*nil, ?interval: nil) -> void
         def initialize(*args, interval: nil)
           super(*args)
           @interval = interval || config_params(:interval) || DEFAULT_INTERVAL
@@ -25,6 +26,7 @@ module Fusuma
 
         attr_reader :interval
 
+        #: () -> IO
         def io
           @io ||= begin
             reader, writer = create_io
@@ -34,6 +36,7 @@ module Fusuma
           end
         end
 
+        #: (IO, IO) -> Thread
         def start(reader, writer)
           Thread.new do
             timer_loop(writer)
@@ -62,6 +65,7 @@ module Fusuma
           MultiLogger.error e
         end
 
+        #: (Time) -> Thread::Queue
         def wake_early(t)
           @early_wake_queue.push(t + EPSILON_TIME)
         end

data/lib/fusuma/plugin/manager.rb

@@ -7,22 +7,27 @@ module Fusuma
   module Plugin
     # Manage Fusuma plugins
     class Manager
+      #: (Class) -> void
       def initialize(plugin_class)
         @plugin_class = plugin_class
       end
 
+      #: () -> Array[untyped]
       def require_siblings_from_plugin_dir
         fusuma_default_plugin_paths.each { |siblings_plugin| require(siblings_plugin) }
       end
 
+      #: () -> Array[untyped]
       def require_siblings_from_gems
         fusuma_external_plugin_paths.each { |siblings_plugin| require(siblings_plugin) }
       end
 
+      #: () -> Regexp
       def exclude_path_pattern
         %r{fusuma/plugin/[^/]*.rb}
       end
 
+      #: () -> Array[untyped]
       def fusuma_default_plugin_paths
         @_fusuma_default_plugin_paths ||= Dir.glob(File.expand_path("#{__dir__}/../../#{search_key}")).grep_v(exclude_path_pattern).sort
       end
@@ -38,7 +43,7 @@ module Fusuma
             raise "Not Found: #{match_data[1]}/#{match_data[2]}/*.gemspec" unless plugin_gemspec_path
 
             plugin_gemspec = Gem::Specification.load(plugin_gemspec_path)
-            fusuma_gemspec_path = File.expand_path("../../../fusuma.gemspec", __dir__)
+            fusuma_gemspec_path = File.expand_path("../../../fusuma.gemspec", __dir__ || ".")
             fusuma_gemspec = Gem::Specification.load(fusuma_gemspec_path)
             next if plugin_gemspec == fusuma_gemspec
 
@@ -56,6 +61,7 @@ module Fusuma
       # @example
       # search_key
       # => "fusuma/plugin/detectors/*rb"
+      #: () -> String
       def search_key
         File.join(plugin_dir_name, "*rb")
       end
@@ -66,6 +72,7 @@ module Fusuma
       #  plugin_dir_name
       #   => "fusuma/plugin/detectors"
       # @return [String]
+      #: () -> String
       def plugin_dir_name
         @plugin_class.name.match(/(Fusuma::.*)::/)[1].to_s.underscore
       end
@@ -101,6 +108,7 @@ module Fusuma
           manager.require_siblings_from_gems
         end
 
+        #: () -> void
         def require_base_plugins
           require_relative "base"
           require_relative "events/event"
@@ -112,6 +120,7 @@ module Fusuma
           require_relative "executors/executor"
         end
 
+        #: () -> Hash[untyped, untyped]
         def plugins
           @plugins ||= {}
         end
@@ -122,6 +131,7 @@ module Fusuma
         #   => ["/path/to/fusuma/lib/fusuma/plugin/inputs/input.rb",
         #       "/path/to/fusuma/lib/fusuma/plugin/inputs/libinput_command_input.rb",
         #       "/path/to/fusuma/lib/fusuma/plugin/inputs/timer_input.rb"]
+        #: () -> Array[untyped]
         def load_paths
           @load_paths ||= []
         end

data/lib/fusuma/plugin/parsers/libinput_gesture_parser.rb

@@ -13,6 +13,7 @@ module Fusuma
 
         # @param record [String]
         # @return [Records::GestureRecord, nil]
+        #: (Fusuma::Plugin::Events::Records::TextRecord) -> Fusuma::Plugin::Events::Records::GestureRecord?
         def parse_record(record)
           case line = record.to_s
           when /GESTURE_SWIPE|GESTURE_PINCH|GESTURE_HOLD/
@@ -29,6 +30,7 @@ module Fusuma
 
         private
 
+        #: (String) -> Array[untyped]
         def parse_libinput(line)
           if libinput_1_27_0_or_later?
             parse_line_1_27_0_or_later(line)
@@ -37,16 +39,19 @@ module Fusuma
           end
         end
 
+        #: () -> bool
         def libinput_1_27_0_or_later?
           return @libinput_1_27_0_or_later if defined?(@libinput_1_27_0_or_later)
 
           @libinput_1_27_0_or_later = Inputs::LibinputCommandInput.new.command.libinput_1_27_0_or_later?
         end
 
+        #: (String) -> Array[untyped]
         def parse_line(line)
           _device, event_name, _time, other = line.strip.split(nil, 4)
           finger, other = other.split(nil, 2)
 
+          return [] unless event_name
           gesture, status = *detect_gesture(event_name)
 
           status = "cancelled" if gesture == "hold" && status == "end" && other == "cancelled"
@@ -54,6 +59,7 @@ module Fusuma
           [gesture, status, finger, delta]
         end
 
+        #: (String) -> Array[untyped]
         def parse_line_1_27_0_or_later(line)
           _device, event_name, other = line.strip.split(nil, 3)
 
@@ -63,6 +69,7 @@ module Fusuma
 
           _time, finger, other = other.split(nil, 3)
 
+          return [] unless event_name
           gesture, status = *detect_gesture(event_name)
 
           status = "cancelled" if gesture == "hold" && status == "end" && other == "cancelled"
@@ -70,6 +77,7 @@ module Fusuma
           [gesture, status, finger, delta]
         end
 
+        #: (String) -> Array[untyped]
         def detect_gesture(event_name)
           event_name =~ /GESTURE_(SWIPE|PINCH|HOLD)_(BEGIN|UPDATE|END)/
           gesture = Regexp.last_match(1).downcase
@@ -77,6 +85,7 @@ module Fusuma
           [gesture, status]
         end
 
+        #: (String?) -> Fusuma::Plugin::Events::Records::GestureRecord::Delta?
         def parse_delta(line)
           return if line.nil?
 

data/lib/fusuma/plugin/parsers/parser.rb

@@ -12,6 +12,7 @@ module Fusuma
         # if `#parse_record` return nil, this method will return original event
         # @param event [Event]
         # @return [Event]
+        #: (Fusuma::Plugin::Events::Event) -> Fusuma::Plugin::Events::Event
         def parse(event)
           return event if event.tag != source
 
@@ -25,10 +26,12 @@ module Fusuma
 
         # Set source for tag from config.yml.
         # DEFAULT_SOURCE is defined in each Parser plugins.
+        #: () -> String
         def source
           @source ||= config_params(:source) || self.class.const_get(:DEFAULT_SOURCE)
         end
 
+        #: () -> String
         def tag
           @tag ||= self.class.name.split("::").last.underscore
         end
@@ -36,6 +39,7 @@ module Fusuma
         # parse Record object
         # @param _record [Record]
         # @return [Record, nil]
+        #: (Fusuma::Plugin::Events::Records::Record) -> Fusuma::Plugin::Events::Records::Record?
         def parse_record(_record)
           nil
         end

data/lib/fusuma/string_support.rb

@@ -6,6 +6,7 @@ class String
     split("_").map(&:capitalize).join
   end
 
+  #: () -> String
   def underscore
     gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
       .gsub(/([a-z\d])([A-Z])/, '\1_\2')

data/lib/fusuma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fusuma
-  VERSION = "3.9.0"
+  VERSION = "3.10.0"
 end

data/lib/fusuma.rb

@@ -12,6 +12,7 @@ module Fusuma
   # main class
   class Runner
     class << self
+      #: (?Hash[untyped, untyped]) -> void
       def run(option = {})
         read_options(option)
         instance = new
@@ -26,6 +27,7 @@ module Fusuma
 
       private
 
+      #: (Hash[untyped, untyped]) -> void
       def read_options(option)
         MultiLogger.filepath = option[:log_filepath]
         MultiLogger.instance.debug_mode = option[:verbose]
@@ -53,13 +55,17 @@ module Fusuma
         Process.daemon if option[:daemon]
       end
 
+      #: (String?) -> void
       def load_custom_config(config_path = nil)
         Config.custom_path = config_path
       end
     end
 
-    def initialize; end
+    #: () -> void
+    def initialize
+    end
 
+    #: () -> void
     def initialize_plugins
       @inputs = Plugin::Inputs::Input.plugins.map do |cls|
         cls.ancestors.include?(Singleton) ? cls.instance : cls.new
@@ -71,6 +77,7 @@ module Fusuma
       @executors = Plugin::Executors::Executor.plugins.map(&:new)
     end
 
+    #: () -> void
     def run
       loop { pipeline }
     end
@@ -193,6 +200,7 @@ module Fusuma
       @buffers.each(&:clear_expired)
     end
 
+    #: () -> void
     def set_trap
       Signal.trap("INT") {
         shutdown
@@ -206,6 +214,7 @@ module Fusuma
 
     private
 
+    #: () -> Array[untyped]
     def shutdown
       [@inputs, @filters, @parsers, @buffers, @detectors, @executors].flatten.compact.each do |plugin|
         plugin.shutdown

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma
 version: !ruby/object:Gem::Version
-  version: 3.9.0
+  version: 3.10.0
 platform: ruby
 authors:
 - iberianpig
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-26 00:00:00.000000000 Z
+date: 2025-10-19 00:00:00.000000000 Z
 dependencies: []
 description: Fusuma is multitouch gesture recognizer. This gem makes your touchpad
   on Linux able to recognize swipes or pinchs and assign command to them. Read installation