fusuma 3.9.0 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25a6fc321e7305354cb3b86d331dd4ec749043eaeef977dc125efbd0a515533f
-  data.tar.gz: 5621071b0f8cf1997dbed8a4cd25afbe7cd9721ee6d9ec0178c201d2fcd20f37
+  metadata.gz: 7161de044b786ed9f12f64be26a497307ba1ea87159760e68b5ac90d87ea1d73
+  data.tar.gz: aa9359be7d9c0bcc6ca283ba5c2aa17b55f07424a26d3f22b056c47b924488bc
 SHA512:
-  metadata.gz: adc8d6c912cb7e650ed51e7c28a021e58a3be91a61190458e7e25bc7450051b01cbc10876c882fde11e70c60575c64163f547dbb6932e5c4a6682792fb995375
-  data.tar.gz: 2796ede1b96046738a3e1feb93f0137a7f4b48fd599752b9b4d6ab047f9ffdcf082f2aaf94ef4988f3cafde150e89522db057222804acdaf8d2f80593ed0d543
+  metadata.gz: 1187109a3b4b3ba67b35feaa274ab73a58dc3411ae8b3de6f62e5ef153c7ca8647383ae0cebeeb8e5632bd69ec0218477826e5e5aa4d32002233a87b521eba43
+  data.tar.gz: eec0e66de8f07b7e64ffec123b16a1b51103701346819b0b048850d83e8bf8a78c020f3d51e889f7ff5474218d534a7e7e6bf834bac36c6ff739f279a06da4c8

data/README.md

@@ -9,7 +9,7 @@ Fusuma is a powerful tool designed to enable multitouch gesture recognition on L
 
 ## Features
 
-- **Easy Installation**: Quick setup via RubyGems.
+- **Easy Installation**: Quick generate via RubyGems.
 - **Flexible Configuration**: Customize gestures and actions freely in YAML file format.
 - **Sensitivity Settings**: Fine-tune gesture recognition with adjustable thresholds and intervals to suit your preferences and enhance precision.
 - **Extension through Plugins**: A [plugin system](https://github.com/iberianpig/fusuma/#fusuma-plugins) allows for additional functionality as needed.
@@ -449,6 +449,32 @@ I'm a Freelance Engineer in Japan and working on these products after finishing
 Currently, my open-source contribution times is not enough.
 If you like my work and want to contribute and become a sponsor, I will be able to focus on my projects.
 
+## Development
+
+### Type Checking
+
+Fusuma uses [RBS](https://github.com/ruby/rbs) for type signatures and [Steep](https://github.com/soutaro/steep) for type checking.
+
+#### Running Type Checks
+
+```sh
+# Generate RBS signatures and run type checking
+bundle exec rake rbs:generate && bundle exec steep check
+
+# Validate RBS files
+bundle exec rake rbs:validate
+
+# Generate inline RBS from code comments
+bundle exec rbs-inline --opt-out lib --output --base .
+```
+
+#### RBS Development
+
+The project uses both traditional RBS files and inline RBS comments:
+- Inline RBS comments in source code (processed by `rbs-inline`)
+- Generated RBS files in `sig/generated/`
+- Type checking via Steep with configuration in `Steepfile`
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/iberianpig/fusuma. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/fusuma/config/index.rb

@@ -5,6 +5,7 @@ module Fusuma
   class Config
     # index for config.yml
     class Index
+      #: (Array[untyped] | String | Symbol | Integer) -> void
       def initialize(keys)
         case keys
         when Array
@@ -21,6 +22,9 @@ module Fusuma
         end
       end
 
+      attr_reader :keys #: Array[Key]
+      attr_reader :cache_key #: Symbol | Integer
+
       def to_s
         @keys.map(&:inspect)
       end
@@ -31,15 +35,18 @@ module Fusuma
         cache_key == other.cache_key
       end
 
-      attr_reader :keys, :cache_key
-
       # Keys in Index
       class Key
+        attr_reader :symbol #: Symbol | Integer
+        attr_reader :skippable #: bool
+
+        #: (String | Integer | Symbol, ?skippable: bool) -> void
         def initialize(symbol_word, skippable: false)
-          @symbol = begin
-            symbol_word.to_sym
-          rescue
+          @symbol = case symbol_word
+          when Integer, Symbol
             symbol_word
+          else
+            symbol_word.to_sym
           end
 
           @skippable = skippable
@@ -52,8 +59,6 @@ module Fusuma
             @symbol.to_s
           end
         end
-
-        attr_reader :symbol, :skippable
       end
     end
   end

data/lib/fusuma/config/searcher.rb

@@ -5,6 +5,7 @@ module Fusuma
   class Config
     # Search config.yml
     class Searcher
+      #: () -> void
       def initialize
         @cache = {}
       end
@@ -14,6 +15,7 @@ module Fusuma
       # @return [NilClass]
       # @return [Hash]
       # @return [Object]
+      #: (Fusuma::Config::Index, location: untyped) -> untyped
       def search(index, location:)
         key = index.keys.first
         return location if key.nil?
@@ -22,7 +24,7 @@ module Fusuma
 
         return nil unless location.is_a?(Hash)
 
-        next_index = Index.new(index.keys[1..-1])
+        next_index = Index.new(Array(index.keys[1..-1]))
 
         value = nil
         next_location_cadidates(location, key).find do |next_location|
@@ -31,6 +33,7 @@ module Fusuma
         value
       end
 
+      #: (Fusuma::Config::Index, location: Array[untyped], context: Hash[untyped, untyped] | nil) -> untyped
       def search_with_context(index, location:, context:)
         return nil if location.nil?
 
@@ -48,12 +51,14 @@ module Fusuma
       # @return [NilClass]
       # @return [Hash]
       # @return [Object]
+      #: (Fusuma::Config::Index, location: Array[untyped])
       def search_with_cache(index, location:)
         cache([index.cache_key, Searcher.context]) do
           search_with_context(index, location: location, context: Searcher.context)
         end
       end
 
+      #: (Array[untyped] | String) { () -> untyped } -> untyped
       def cache(key)
         key = key.join(",") if key.is_a? Array
         if @cache.key?(key)
@@ -68,6 +73,7 @@ module Fusuma
       # next locations' candidates sorted by priority
       #  1. look up location with key
       #  2. skip the key and go to child location
+      #: (Hash[untyped, untyped], Fusuma::Config::Index::Key) -> Array[untyped]
       def next_location_cadidates(location, key)
         [
           location[key.symbol],
@@ -81,19 +87,20 @@ module Fusuma
         # Search with context from load_streamed Config
         # @param context [Hash]
         # @return [Object]
+        #: (?Hash[untyped, untyped]) { () -> untyped } -> untyped
         def with_context(context = {}, &block)
           before = @context
           @context = context
-          result = block.call
+          block.call
         ensure # NOTE: ensure is called even if return in block
           @context = before
-          result
         end
 
         CONTEXT_SEARCH_ORDER = [:no_context, :complete_match_context, :partial_match_context]
         # Return a matching context from config
         # @params request_context [Hash]
         # @return [Hash]
+        #: (Hash[untyped, untyped], ?Array[untyped]) { () -> untyped } -> Hash[untyped, untyped]?
         def find_context(request_context, fallbacks = CONTEXT_SEARCH_ORDER, &block)
           # Search in blocks in the following order.
           # 1. primary context(no context)
@@ -113,6 +120,7 @@ module Fusuma
         # No context(primary context)
         # @return [Hash]
         # @return [NilClass]
+        #: (Hash[untyped, untyped]) { () -> untyped } -> Hash[untyped, untyped]?
         def no_context(_request_context, &block)
           {} if with_context({}, &block)
         end
@@ -121,6 +129,7 @@ module Fusuma
         # @param request_context [Hash]
         # @return [Hash] matched context
         # @return [NilClass] if not matched
+        #: (Hash[untyped, untyped]) { () -> untyped } -> Hash[untyped, untyped]?
         def complete_match_context(request_context, &block)
           Config.instance.keymap.each do |config|
             next unless config[:context] == request_context
@@ -133,6 +142,7 @@ module Fusuma
         # @param request_context [Hash]
         # @return [Hash] matched context
         # @return [NilClass] if not matched
+        #: (Hash[untyped, untyped]) { () -> untyped } -> Hash[untyped, untyped]?
         def partial_match_context(request_context, &block)
           if request_context.keys.size > 1
             Config.instance.keymap.each do |config|
@@ -155,6 +165,7 @@ module Fusuma
         # @param request_context [Hash]
         # @return [Hash] matched context
         # @return [NilClass] if not matched
+        #: (Hash[untyped, untyped]) { () -> untyped } -> Hash[untyped, untyped]?
         def plugin_default_context(request_context, &block)
           complete_match_context = nil
           Config.instance.keymap.each do |config|
@@ -167,9 +178,9 @@ module Fusuma
 
             return config[:context] if with_context(config[:context], &block)
           end
-          if complete_match_context
-            with_context(complete_match_context, &block)
-            complete_match_context
+
+          complete_match_context&.tap do |context|
+            with_context(context, &block)
           end
         end
       end

data/lib/fusuma/config/yaml_duplication_checker.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
+require "yaml"
+
 module Fusuma
   class Config
     # ref: https://github.com/rubocop-hq/rubocop/blob/97e4ffc8a71e9e5239a927c6a534dfc1e0da917f/lib/rubocop/yaml_duplication_checker.rb
     # Find duplicated keys from YAML.
+    # steep:ignore:start
     module YAMLDuplicationChecker
+      #: (String, String) { (string) -> void }  -> void
       def self.check(yaml_string, filename, &on_duplicated)
         tree = YAML.parse(yaml_string, filename: filename)
         return unless tree
@@ -12,6 +16,7 @@ module Fusuma
         traverse(tree, &on_duplicated)
       end
 
+      #: (untyped) { () -> void } -> Array[untyped]?
       def self.traverse(tree, &on_duplicated)
         case tree
         when Psych::Nodes::Mapping
@@ -31,5 +36,6 @@ module Fusuma
 
       private_class_method :traverse
     end
+    # steep:ignore:end
   end
 end

data/lib/fusuma/config.rb

@@ -20,6 +20,7 @@ module Fusuma
     include Singleton
 
     class << self
+      #: (Fusuma::Config::Index) -> (String | Hash[untyped, untyped] | Integer | Float)?
       def search(index)
         instance.search(index)
       end
@@ -28,6 +29,7 @@ module Fusuma
         instance.find_execute_key(index)
       end
 
+      #: (String?) -> Fusuma::Config
       def custom_path=(new_path)
         instance.custom_path = new_path
       end
@@ -35,22 +37,26 @@ module Fusuma
 
     attr_reader :custom_path, :searcher
 
+    #: () -> void
     def initialize
       @searcher = Searcher.new
       @custom_path = nil
       @keymap = nil
     end
 
+    #: (String?) -> Fusuma::Config
     def custom_path=(new_path)
       @custom_path = new_path
       reload
     end
 
+    #: () -> Array[untyped]?
     def keymap
       # FIXME: @keymap is not initialized when called from outside Fusuma::Runner like fusuma-senkey
       @keymap || reload.keymap
     end
 
+    #: () -> Fusuma::Config
     def reload
       plugin_defaults = plugin_defaults_paths.map do |default_yml|
         {
@@ -76,6 +82,7 @@ module Fusuma
     # @param key [Symbol]
     # @param base [Config::Index]
     # @return [Hash]
+    #: (Symbol?, Fusuma::Config::Index) -> (String | Hash[untyped, untyped] | Float | Integer | bool)?
     def fetch_config_params(key, base)
       request_context = {plugin_defaults: base.keys.last.symbol.to_s}
       fallbacks = [:no_context, :plugin_default_context]
@@ -90,15 +97,16 @@ module Fusuma
 
     # @return [Hash] If check passes
     # @raise [InvalidFileError] If check does not pass
+    #: (String) -> Array[Hash[Symbol, untyped]]
     def validate(path)
       duplicates = []
-      YAMLDuplicationChecker.check(File.read(path), path) do |ignored, duplicate|
+      YAMLDuplicationChecker.check(File.read(path), path) do |ignored, duplicate| # steep:ignore UnexpectedBlockGiven
         MultiLogger.error "#{path}: #{ignored.value} is duplicated"
         duplicates << duplicate.value
       end
       raise InvalidFileError, "Detect duplicate keys #{duplicates}" unless duplicates.empty?
 
-      yamls = YAML.load_stream(File.read(path)).compact
+      yamls = YAML.load_stream(File.read(path)).compact # steep:ignore NoMethod
       yamls.map do |yaml|
         raise InvalidFileError, "Invalid config.yml: #{path}" unless yaml.is_a? Hash
 
@@ -109,7 +117,9 @@ module Fusuma
     end
 
     # @param index [Index]
+    #: (Fusuma::Config::Index) -> (String | Hash[untyped, untyped] | Integer | Float)?
     def search(index)
+      return nil if index.nil? || index.keys.empty?
       @searcher.search_with_cache(index, location: keymap)
     end
 
@@ -120,7 +130,7 @@ module Fusuma
         executor.new.execute_keys
       end.flatten
 
-      @cache_execute_keys ||= {}
+      @cache_execute_keys ||= {} #: Hash[String, untyped]
 
       cache_key = [index.cache_key, Searcher.context].join
 
@@ -135,6 +145,7 @@ module Fusuma
 
     private
 
+    #: () -> String
     def find_config_filepath
       filename = "fusuma/config.yml"
       if custom_path
@@ -149,10 +160,12 @@ module Fusuma
       end
     end
 
+    #: () -> String
     def expand_custom_path
       File.expand_path(custom_path)
     end
 
+    #: (String) -> String
     def expand_config_path(filename)
       File.expand_path "~/.config/#{filename}"
     end
@@ -161,6 +174,7 @@ module Fusuma
       File.expand_path "../../#{filename}", __FILE__
     end
 
+    #: () -> Array[untyped]
     def plugin_defaults_paths
       Plugin::Manager.load_paths.map do |plugin_path|
         yml = plugin_path.gsub(/\.rb$/, ".yml")

data/lib/fusuma/custom_process.rb

@@ -7,10 +7,12 @@ module Fusuma
   module CustomProcess
     attr_writer :proctitle
 
+    #: () -> Array[untyped]
     def child_pids
       @child_pids ||= []
     end
 
+    #: () { () -> void } -> nil
     def fork
       pid = Process.fork do
         Process.setproctitle(proctitle)
@@ -35,6 +37,7 @@ module Fusuma
       end
     end
 
+    #: () -> String
     def proctitle
       @proctitle ||= self.class.name.underscore
     end

data/lib/fusuma/device.rb

@@ -8,6 +8,7 @@ module Fusuma
   class Device
     attr_reader :id, :name, :capabilities, :available
 
+    #: (?id: nil | String, ?name: nil | String, ?capabilities: nil, ?available: nil | bool) -> void
     def initialize(id: nil, name: nil, capabilities: nil, available: nil)
       @id = id
       @name = name
@@ -16,6 +17,7 @@ module Fusuma
     end
 
     # @param attributes [Hash]
+    #: (Hash[untyped, untyped]) -> Hash[untyped, untyped]
     def assign_attributes(attributes)
       attributes.each do |k, v|
         case k
@@ -35,6 +37,7 @@ module Fusuma
       # Return devices
       # sort devices by capabilities of gesture
       # @return [Array]
+      #: () -> Array[Device]
       def all
         @all ||= fetch_devices.partition do |d|
           d.capabilities.match?(/gesture/)
@@ -43,6 +46,7 @@ module Fusuma
 
       # @raise [SystemExit]
       # @return [Array]
+      #: () -> Array[Device]
       def available
         @available ||= all.select(&:available).tap do |d|
           MultiLogger.debug(available_devices: d)
@@ -54,6 +58,7 @@ module Fusuma
         exit 1
       end
 
+      #: () -> nil
       def reset
         @all = nil
         @available = nil
@@ -62,6 +67,7 @@ module Fusuma
       private
 
       # @return [Array]
+      #: () -> Array[Device]
       def fetch_devices
         line_parser = LineParser.new
 
@@ -72,6 +78,7 @@ module Fusuma
         line_parser.generate_devices
       end
 
+      #: () -> Fusuma::LibinputCommand
       def libinput_command
         @libinput_command ||= Plugin::Inputs::LibinputCommandInput.new.command
       end
@@ -81,16 +88,19 @@ module Fusuma
     class LineParser
       attr_reader :lines
 
+      #: () -> void
       def initialize
         @lines = []
       end
 
       # @param line [String]
+      #: (String) -> Array[untyped]
       def push(line)
         lines.push(line)
       end
 
       # @return [Array]
+      #: () -> Array[Device]
       def generate_devices
         lines.each_with_object([]) do |line, devices|
           attributes = extract_attribute(line: line)
@@ -108,6 +118,7 @@ module Fusuma
 
       # @param line [String]
       # @return [Hash]
+      #: (line: String) -> Hash[untyped, untyped]
       def extract_attribute(line:)
         if (id = id_from(line))
           {id: id}
@@ -122,24 +133,28 @@ module Fusuma
         end
       end
 
+      #: (String) -> String?
       def id_from(line)
         line.match("^Kernel:[[:space:]]*") do |m|
           m.post_match.match(/event[0-9]+/).to_s
         end
       end
 
+      #: (String) -> String?
       def name_from(line)
         line.match("^Device:[[:space:]]*") do |m|
           m.post_match.strip
         end
       end
 
+      #: (String) -> String?
       def capabilities_from(line)
         line.match("^Capabilities:[[:space:]]*") do |m|
           m.post_match.strip
         end
       end
 
+      #: (String) -> bool?
       def available_from(line)
         # NOTE: is natural scroll available?
         if /^Nat.scrolling: /.match?(line)

data/lib/fusuma/environment.rb

@@ -8,6 +8,7 @@ module Fusuma
   # Output Environment information
   class Environment
     class << self
+      #: () -> void
       def dump_information
         MultiLogger.info "---------------------------------------------"
         print_version
@@ -16,6 +17,7 @@ module Fusuma
         MultiLogger.info "---------------------------------------------"
       end
 
+      #: () -> void
       def print_version
         libinput_command = Plugin::Inputs::LibinputCommandInput.new.command
         MultiLogger.info "Fusuma: #{VERSION}"
@@ -26,6 +28,7 @@ module Fusuma
         MultiLogger.info "Desktop session: #{`echo $DESKTOP_SESSION $XDG_SESSION_TYPE`}".strip
       end
 
+      #: () -> void
       def print_enabled_plugins
         MultiLogger.info "Enabled Plugins: "
         Plugin::Manager.plugins
@@ -34,6 +37,7 @@ module Fusuma
           .flatten.sort.each { |name| MultiLogger.info(name) }
       end
 
+      #: () -> void
       def print_device_list
         Plugin::Filters::LibinputDeviceFilter.new.keep_device.all.map do |device|
           puts device.name

data/lib/fusuma/hash_support.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-# Patch to hash
+# @rbs generic unchecked out K
+# @rbs generic unchecked out V
 class Hash
   # activesupport-5.2.0/lib/active_support/core_ext/hash/deep_merge.rb
   def deep_merge(other_hash, &block)
@@ -25,6 +26,7 @@ class Hash
   end
 
   # activesupport-4.1.1/lib/active_support/core_ext/hash/keys.rb
+  #: () -> Hash[Symbol, untyped]
   def deep_symbolize_keys
     deep_transform_keys do |key|
       key.to_sym
@@ -33,6 +35,7 @@ class Hash
     end
   end
 
+  #: [T] () { (untyped) -> T } -> Hash[T, untyped]
   def deep_transform_keys(&block)
     result = {}
     each do |key, value|
@@ -42,6 +45,7 @@ class Hash
   end
 
   # activesupport/lib/active_support/core_ext/hash/deep_transform_values.rb
+  #: () { (untyped) -> untyped } -> Hash[untyped, untyped]
   def deep_transform_values(&block)
     _deep_transform_values_in_object(self, &block)
   end
@@ -49,6 +53,7 @@ class Hash
   private
 
   # Support methods for deep transforming nested hashes and arrays.
+  #: (Hash[untyped, untyped]) { (untyped) -> untyped } -> Hash[untyped, untyped]
   def _deep_transform_values_in_object(object, &block)
     case object
     when Hash

data/lib/fusuma/libinput_command.rb

@@ -5,6 +5,7 @@ require "open3"
 module Fusuma
   # Execute libinput command
   class LibinputCommand
+    #: (?libinput_options: Array[String], ?commands: Hash[untyped, untyped]) -> void
     def initialize(libinput_options: [], commands: {})
       @libinput_command = commands[:libinput_command]
       @debug_events_command = commands[:debug_events_command]
@@ -17,6 +18,7 @@ module Fusuma
     NEW_CLI_OPTION_VERSION = "1.8"
 
     # @return [Boolean]
+    #: () -> bool
     def new_cli_option_available?
       Gem::Version.new(version) >= Gem::Version.new(NEW_CLI_OPTION_VERSION)
     end
@@ -27,32 +29,35 @@ module Fusuma
     end
 
     # @return [String]
+    #: () -> String?
     def version
       # version_command prints "1.6.3\n"
       @version ||= `#{version_command}`.strip
     end
 
     # @yieldparam [String] gives a line in libinput list-devices output to the block
+    #: () { (String) -> void } -> void
     def list_devices(&block)
       cmd = list_devices_command
       MultiLogger.debug(list_devices: cmd)
-      o, e, s = Open3.capture3(cmd)
+      o, _, s = Open3.capture3(cmd)
 
       unless s.success?
-        MultiLogger.error("libinput list-devices failed with output: #{o}")
-        return
+        raise "libinput list-devices failed with output: #{o}"
       end
 
       o.each_line(&block)
     end
 
     # @return [Integer] return a latest line libinput debug-events
+    #: (StringIO) -> Array[untyped]
     def debug_events(writer)
       Open3.pipeline_start([debug_events_with_options], ["grep -v POINTER_ --line-buffered"], out: writer, in: "/dev/null")
     end
 
     # @return [String] command
     # @raise [SystemExit]
+    #: () -> String?
     def version_command
       if @libinput_command
         "#{@libinput_command} --version"
@@ -68,6 +73,7 @@ module Fusuma
       end
     end
 
+    #: () -> String
     def list_devices_command
       if @libinput_command
         @libinput_command + " list-devices"
@@ -80,6 +86,7 @@ module Fusuma
       end
     end
 
+    #: () -> String
     def debug_events_command
       if @libinput_command
         @libinput_command + " debug-events"
@@ -92,6 +99,7 @@ module Fusuma
       end
     end
 
+    #: () -> String
     def debug_events_with_options
       prefix = "stdbuf -oL --"
       "#{prefix} #{debug_events_command} #{@libinput_options.join(" ")}".strip