fusuma 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4670e37d93cd689661c036a4d2a25361af7a283f407b3ffc98dd1d275d6ef675
-  data.tar.gz: 78735688ac87ab4c09ebd0f7b69000a56e5543916bd41b490df02b7130525832
+  metadata.gz: 30a12dfc770118352a414806a6c37e376eebdf49db24aa347eb904146b855ecf
+  data.tar.gz: ef9fb2e5bbbdc4a53eafae83334455890ad99b3c91c43ad0e4ed678f38bb1673
 SHA512:
-  metadata.gz: 998e0a7cd21c42870a7b747a0280f4aa55695bea79139f0bef3b2dbcedefc448548f4ed261b2993a67c6e9e5921fa2dcab93b595153fc9b9a04818816fdf605f
-  data.tar.gz: 8892cf28ab5d7bce157fbf7eca3c9458565585b223d36f9c15f7cc0b2d3d08248c643504f00bc33aac51b88e86270c59b3c886d968e1ce52f7f51a4614dcb16e
+  metadata.gz: ecb619087432fc99c51265b91ed1fc21da77e34e13d446a92c29127d15e3e7c35124b2a67df7a184891d76f0ad004151eb1e5d92df170334f5a668eebdb93941
+  data.tar.gz: b8da3242044d824d0f39170cf16a3e173214742e01cfe965257a146dfe5a1993d19232d50d5b26dd264956ace6d488ee09b5d7e873de7f45e442ad75646bc41c

data/README.md

@@ -403,8 +403,8 @@ Fusuma plugins are provided with the `fusuma-plugin-XXXXX` naming convention and
 | [fusuma-plugin-sendkey](https://github.com/iberianpig/fusuma-plugin-sendkey)       | ![Gem](https://img.shields.io/gem/v/fusuma-plugin-sendkey?color=brightgreen)    | Emulates keyboard events(Wayland compatible)                 |
 | [fusuma-plugin-wmctrl](https://github.com/iberianpig/fusuma-plugin-wmctrl)         | ![Gem](https://img.shields.io/gem/v/fusuma-plugin-wmctrl?color=brightgreen)     | Manages Window and Workspace                                 |
 | [fusuma-plugin-keypress](https://github.com/iberianpig/fusuma-plugin-keypress)     | ![Gem](https://img.shields.io/gem/v/fusuma-plugin-keypress?color=brightgreen)   | Detecting a combination of key presses and touchpad gestures |
-| [fusuma-plugin-tap](https://github.com/iberianpig/fusuma-plugin-tap)               | ![Gem](https://img.shields.io/gem/v/fusuma-plugin-tap?color=brightgreen)        | Detects Tap gesture                                          |
 | [fusuma-plugin-appmatcher](https://github.com/iberianpig/fusuma-plugin-appmatcher) | ![Gem](https://img.shields.io/gem/v/fusuma-plugin-appmatcher?color=brightgreen) | Configure app-specific gestures                              |
+| [fusuma-plugin-thumbsense](https://github.com/iberianpig/fusuma-plugin-thumbsense) | ![Gem](https://img.shields.io/gem/v/fusuma-plugin-thumbsense?color=brightgreen) | Remapper from key to click only while tapping                |
 
 
 ### Installation of Fusuma plugins

data/exe/fusuma

@@ -27,6 +27,10 @@ opt.on('--log=path/to/file',
   option[:log_filepath] = v
 end
 
+opt.on('--show-config', 'Show config as YAML format which is loaded internally') do |v|
+  option[:show_config] = v
+end
+
 opt.on('--device="Device name"',
        'Open the given device only (DEPRECATED)') do |v|
   option[:device] = v

data/fusuma.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
     "yard.run" => "yri" # use "yard" to build full HTML docs.
   }
 
-  spec.required_ruby_version = ">= 2.5.1" # https://packages.ubuntu.com/search?keywords=ruby&searchon=names&exact=1&suite=all&section=main
-  # support bionic (18.04LTS) 2.5.1
+  spec.required_ruby_version = ">= 2.7"
+  # https://packages.ubuntu.com/search?keywords=ruby&searchon=names&exact=1&suite=all&section=main
+  # support focal (20.04LTS) 2.7
 end

data/lib/fusuma/config/index.rb

@@ -44,7 +44,7 @@ module Fusuma
           if @skippable
             "#{@symbol}(skippable)"
           else
-            "#{@symbol}"
+            @symbol.to_s
           end
         end
 

data/lib/fusuma/config/searcher.rb

@@ -76,6 +76,8 @@ module Fusuma
       end
 
       class << self
+        attr_reader :context
+
         # Search with context from load_streamed Config
         # @param context [Hash]
         # @return [Object]
@@ -86,20 +88,50 @@ module Fusuma
           result
         end
 
+        CONEXT_SEARCH_ORDER = [:no_context, :complete_match_context, :partial_match_context]
         # Return a matching context from config
         # @params request_context [Hash]
         # @return [Hash]
-        def find_context(request_context, &block)
+        def find_context(request_context, fallbacks = CONEXT_SEARCH_ORDER, &block)
           # Search in blocks in the following order.
           # 1. primary context(no context)
           # 2. complete match config[:context] == request_context
           # 3. partial match config[:context] =~ request_context
+          # no_context?(&block) ||
+          #   complete_match_context(request_context, &block) ||
+          #   partial_match_context(request_context, &block)
+          fallbacks.each do |method|
+            result = send(method, request_context, &block)
+            return result if result
+          end
+        end
+
+        private
+
+        # No context(primary context)
+        # @return [Hash]
+        # @return [NilClass]
+        def no_context(_request_context, &block)
           return {} if with_context({}, &block)
+        end
 
+        # Complete match request context
+        # @param request_context [Hash]
+        # @return [Hash] matched context
+        # @return [NilClass] if not matched
+        def complete_match_context(request_context, &block)
           Config.instance.keymap.each do |config|
             next unless config[:context] == request_context
             return config[:context] if with_context(config[:context], &block)
           end
+          nil
+        end
+
+        # One of multiple request contexts matched
+        # @param request_context [Hash]
+        # @return [Hash] matched context
+        # @return [NilClass] if not matched
+        def partial_match_context(request_context, &block)
           if request_context.keys.size > 1
             Config.instance.keymap.each do |config|
               next if config[:context].nil?
@@ -107,11 +139,34 @@ module Fusuma
               next unless config[:context].all? { |k, v| request_context[k] == v }
               return config[:context] if with_context(config[:context], &block)
             end
+            nil
           end
         end
 
-        attr_reader :context
+        # Search context for plugin
+        # If the plugin_defaults key is a complete match,
+        # it is the default value for that plugin, so it is postponed.
+        # This is because prioritize overwriting by other plugins.
+        # The search order is as follows
+        # 1. complete match config[:context].key?(:plugin_defaults)
+        # 2. complete match config[:context] == request_context
+        # @param request_context [Hash]
+        # @return [Hash] matched context
+        # @return [NilClass] if not matched
+        def plugin_default_context(request_context, &block)
+          complete_match_context = nil
+          Config.instance.keymap.each do |config|
+            next unless config[:context]&.key?(:plugin_defaults)
+
+            if config[:context][:plugin_defaults] == request_context[:plugin_defaults]
+              complete_match_context = config[:context]
+              next
+            end
 
+            return config[:context] if with_context(config[:context], &block)
+          end
+          complete_match_context
+        end
       end
     end
   end

data/lib/fusuma/config.rb

@@ -4,6 +4,7 @@ require_relative "./multi_logger"
 require_relative "./config/index"
 require_relative "./config/searcher"
 require_relative "./config/yaml_duplication_checker"
+require_relative "./plugin/manager"
 require_relative "./hash_support"
 require "singleton"
 require "yaml"
@@ -32,7 +33,7 @@ module Fusuma
       end
     end
 
-    attr_reader :keymap, :custom_path, :searcher
+    attr_reader :custom_path, :searcher
 
     def initialize
       @searcher = Searcher.new
@@ -45,17 +46,47 @@ module Fusuma
       reload
     end
 
+    def keymap
+      # FIXME: @keymap is not initialized when called from outside Fusuma::Runner like fusuma-senkey
+      @keymap || reload.keymap
+    end
+
     def reload
+      plugin_defaults = plugin_defaults_paths.map do |default_yml|
+        {
+          context: {plugin_defaults: default_yml.split("/").last.delete_suffix(".yml")},
+          **validate(default_yml)[0]
+        }
+      end
+
+      config_path = find_config_filepath
+      @keymap = validate(config_path) | plugin_defaults
+      MultiLogger.info "reload config: #{config_path}"
+
+      # reset searcher cache
       @searcher = Searcher.new
-      path = find_filepath
-      MultiLogger.info "reload config: #{path}"
-      @keymap = validate(path)
+
       self
     rescue InvalidFileError => e
       MultiLogger.error e.message
       exit 1
     end
 
+    # @param key [Symbol]
+    # @param base [Config::Index]
+    # @return [Hash]
+    def fetch_config_params(key, base)
+      request_context = {plugin_defaults: base.keys.last.symbol.to_s}
+      fallbacks = [:no_context, :plugin_default_context]
+      Config::Searcher.find_context(request_context, fallbacks) do
+        ret = Config.search(base)
+        if ret&.key?(key)
+          return ret
+        end
+      end
+      {}
+    end
+
     # @return [Hash] If check passes
     # @raise [InvalidFileError] If check does not pass
     def validate(path)
@@ -75,7 +106,6 @@ module Fusuma
     end
 
     # @param index [Index]
-    # @param context [Hash]
     def search(index)
       @searcher.search_with_cache(index, location: keymap)
     end
@@ -95,7 +125,7 @@ module Fusuma
 
     private
 
-    def find_filepath
+    def find_config_filepath
       filename = "fusuma/config.yml"
       if custom_path
         return expand_custom_path if File.exist?(expand_custom_path)
@@ -120,5 +150,12 @@ module Fusuma
     def expand_default_path(filename)
       File.expand_path "../../#{filename}", __FILE__
     end
+
+    def plugin_defaults_paths
+      Plugin::Manager.load_paths.map do |plugin_path|
+        yml = plugin_path.gsub(/\.rb$/, ".yml")
+        yml if File.exist?(yml)
+      end.compact
+    end
   end
 end

data/lib/fusuma/custom_process.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "fusuma/string_support"
+require_relative "./string_support"
 
 module Fusuma
   # Rename process

data/lib/fusuma/environment.rb

@@ -39,6 +39,12 @@ module Fusuma
           puts device.name
         end
       end
+
+      def print_config
+        Config.instance.keymap.each do |conf|
+          puts conf.deep_stringify_keys.to_yaml
+        end
+      end
     end
   end
 end

data/lib/fusuma/hash_support.rb

@@ -2,6 +2,28 @@
 
 # Patch to hash
 class Hash
+  # activesupport-5.2.0/lib/active_support/core_ext/hash/deep_merge.rb
+  def deep_merge(other_hash, &block)
+    dup.deep_merge!(other_hash, &block)
+  end
+
+  # Same as +deep_merge+, but modifies +self+.
+  def deep_merge!(other_hash, &block)
+    merge!(other_hash) do |key, this_val, other_val|
+      if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+        this_val.deep_merge(other_val, &block)
+      elsif block
+        block.call(key, this_val, other_val)
+      else
+        other_val
+      end
+    end
+  end
+
+  def deep_stringify_keys
+    deep_transform_keys(&:to_s)
+  end
+
   # activesupport-4.1.1/lib/active_support/core_ext/hash/keys.rb
   def deep_symbolize_keys
     deep_transform_keys do |key|

data/lib/fusuma/plugin/base.rb

@@ -31,14 +31,20 @@ module Fusuma
         raise NotImplementedError, "override #{self.class.name}##{__method__}"
       end
 
+      # @param key [Symbol]
+      # @param base [Config::Index]
       # @return [Object]
-      def config_params(key = nil, base: config_index)
-        params = Config.search(base) || {}
+      def config_params(key = nil)
+        @config_params ||= {}
+        if @config_params["#{config_index.cache_key},#{key}"]
+          return @config_params["#{config_index.cache_key},#{key}"]
+        end
+
+        params = Config.instance.fetch_config_params(key, config_index)
 
         return params unless key
 
-        @config_params ||= {}
-        @config_params["#{base.cache_key},#{key}"] ||=
+        @config_params["#{config_index.cache_key},#{key}"] =
           params.fetch(key, nil).tap do |val|
             next if val.nil?
 
@@ -48,14 +54,14 @@ module Fusuma
             next if param_types.any? { |klass| val.is_a?(klass) }
 
             MultiLogger.error("Please fix config.yml.")
-            MultiLogger.error(":#{base.keys.map(&:symbol)
+            MultiLogger.error(":#{config_index.keys.map(&:symbol)
             .join(" => :")} => :#{key} should be #{param_types.join(" OR ")}.")
             exit 1
           end
       end
 
       def config_index
-        Config::Index.new(self.class.name.gsub("Fusuma::", "").underscore.split("/"))
+        @config_index ||= Config::Index.new(self.class.name.gsub("Fusuma::", "").underscore.split("/"))
       end
     end
   end

data/lib/fusuma/plugin/buffers/gesture_buffer.rb

@@ -11,7 +11,6 @@ module Fusuma
         DEFAULT_SOURCE = "libinput_gesture_parser"
         DEFAULT_SECONDS_TO_KEEP = 100
 
-
         def initialize(*args)
           super(*args)
           @cache = {}
@@ -84,15 +83,15 @@ module Fusuma
         # @param attr [Symbol]
         # @return [Float]
         def sum_last10_attrs(attr) # sums last 10 values of attr (or all if length < 10)
-          cache_entry = ( @cache_sum10[attr] ||= CacheEntry.new(0, 0) )
+          cache_entry = (@cache_sum10[attr] ||= CacheEntry.new(0, 0))
           upd_ev = updating_events
-          if upd_ev.length > cache_entry.checked + 1 then
+          if upd_ev.length > cache_entry.checked + 1
             cache_entry.value = upd_ev.last(10).map do |gesture_event|
               gesture_event.record.delta[attr].to_f
             end.reduce(:+)
           elsif upd_ev.length > cache_entry.checked
             cache_entry.value = cache_entry.value + upd_ev[-1].record.delta[attr].to_f - \
-              (upd_ev.length > 10 ? upd_ev[-11].record.delta[attr].to_f : 0)
+              ((upd_ev.length > 10) ? upd_ev[-11].record.delta[attr].to_f : 0)
           else
             return cache_entry.value
           end
@@ -101,7 +100,7 @@ module Fusuma
         end
 
         def updating_events
-          cache_entry = ( @cache[:updating_events] ||= CacheEntry.new(0, []) )
+          cache_entry = (@cache[:updating_events] ||= CacheEntry.new(0, []))
           cache_entry.checked.upto(@events.length - 1).each do |i|
             (cache_entry.value << @events[i]) if @events[i].record.status == "update"
           end
@@ -140,7 +139,7 @@ module Fusuma
         end
 
         def select_by_type(type)
-          cache_entry = ( @cache_select_by[type] ||= CacheEntry.new(0, self.class.new([])) )
+          cache_entry = (@cache_select_by[type] ||= CacheEntry.new(0, self.class.new([])))
           cache_entry.checked.upto(@events.length - 1).each do |i|
             (cache_entry.value.events << @events[i]) if @events[i].record.gesture == type
           end
@@ -150,7 +149,7 @@ module Fusuma
 
         def select_from_last_begin
           return self if empty?
-          cache_entry = ( @cache[:last_begin] ||= CacheEntry.new(0, nil) )
+          cache_entry = (@cache[:last_begin] ||= CacheEntry.new(0, nil))
 
           cache_entry.value = (@events.length - 1).downto(cache_entry.checked).find do |i|
             @events[i].record.status == "begin"

data/lib/fusuma/plugin/detectors/hold_detector.rb

@@ -11,10 +11,14 @@ module Fusuma
         SOURCES = %w[gesture timer].freeze
         BUFFER_TYPE = "gesture"
         GESTURE_RECORD_TYPE = "hold"
-        Timer = Inputs::TimerInput.instance
 
         BASE_THERESHOLD = 0.7
 
+        def initialize(*args)
+          super(*args)
+          @timer = Inputs::TimerInput.instance
+        end
+
         # @param buffers [Array<Buffers::Buffer>]
         # @return [Events::Event] if event is detected
         # @return [Array<Events::Event>] if hold end event is detected
@@ -50,10 +54,10 @@ module Fusuma
           repeat_index = create_repeat_index(finger: finger, status: status)
           oneshot_index = create_oneshot_index(finger: finger)
 
-          if status == "begin" then
+          if status == "begin"
             @timeout = nil
-            if threshold(index: oneshot_index) < Timer.interval then
-              Timer.wake_early(Time.now + threshold(index: oneshot_index))
+            if threshold(index: oneshot_index) < @timer.interval
+              @timer.wake_early(Time.now + threshold(index: oneshot_index))
             end
           elsif status == "timer"
             return if @timeout
@@ -115,10 +119,10 @@ module Fusuma
 
         def enough?(index:, holding_time:)
           diff = threshold(index: index) - holding_time
-          if diff < 0 then
+          if diff < 0
             true
-          elsif diff < Timer.interval
-            Timer.wake_early(Time.now + diff)
+          elsif diff < @timer.interval
+            @timer.wake_early(Time.now + diff)
             false
           end
         end

data/lib/fusuma/plugin/detectors/swipe_detector.rb

@@ -167,7 +167,7 @@ module Fusuma
           end
 
           def calc
-            @x > @y ? @x.abs : @y.abs
+            (@x > @y) ? @x.abs : @y.abs
           end
         end
       end

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

@@ -14,6 +14,7 @@ module Fusuma
           {
             device: [String],
             "enable-dwt": [TrueClass, FalseClass],
+            "disable-dwt": [TrueClass, FalseClass],
             "enable-tap": [TrueClass, FalseClass],
             "show-keycodes": [TrueClass, FalseClass],
             verbose: [TrueClass, FalseClass],
@@ -47,14 +48,16 @@ module Fusuma
           device = ("--device='#{config_params(:device)}'" if config_params(:device))
           enable_tap = "--enable-tap" if config_params(:"enable-tap")
           enable_dwt = "--enable-dwt" if config_params(:"enable-dwt")
+          disable_dwt = "--disable-dwt" if config_params(:"disable-dwt")
           show_keycodes = "--show-keycodes" if config_params(:"show-keycodes")
           verbose = "--verbose" if config_params(:verbose)
           [
             device,
-            enable_dwt,
             enable_tap,
+            enable_dwt,
+            disable_dwt,
             show_keycodes,
-            verbose
+            verbose,
           ].compact
         end
 

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

@@ -0,0 +1,3 @@
+plugin:
+  inputs:
+    libinput_command_input:

data/lib/fusuma/plugin/manager.rb

@@ -115,6 +115,12 @@ module Fusuma
           @plugins ||= {}
         end
 
+        # @return [Array<String>]
+        # @example
+        #   Manager.load_paths
+        #   => ["/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"]
         def load_paths
           @load_paths ||= []
         end

data/lib/fusuma/version.rb

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

data/lib/fusuma.rb

@@ -27,13 +27,18 @@ module Fusuma
         MultiLogger.filepath = option[:log_filepath]
         MultiLogger.instance.debug_mode = option[:verbose]
 
-        load_custom_config(option[:config_path])
-
         Plugin::Manager.require_base_plugins
 
+        load_custom_config(option[:config_path])
+
         Environment.dump_information
         Kernel.exit(0) if option[:version]
 
+        if option[:show_config]
+          Environment.print_config
+          Kernel.exit(0)
+        end
+
         if option[:list]
           Environment.print_device_list
           Kernel.exit(0)
@@ -147,7 +152,7 @@ module Fusuma
       matched_context = nil
       event = main_events.find do |main_event|
         matched_context = Config::Searcher.find_context(request_context) do
-          if modified_record = main_event.record.merge(records: modifiers.map(&:record))
+          if (modified_record = main_event.record.merge(records: modifiers.map(&:record)))
             main_event.record = modified_record
           elsif !modifiers.empty?
             # try basically the same, but without any modifiers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - iberianpig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-19 00:00:00.000000000 Z
+date: 2023-09-24 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
@@ -59,6 +59,7 @@ files:
 - lib/fusuma/plugin/filters/libinput_device_filter.rb
 - lib/fusuma/plugin/inputs/input.rb
 - lib/fusuma/plugin/inputs/libinput_command_input.rb
+- lib/fusuma/plugin/inputs/libinput_command_input.yml
 - lib/fusuma/plugin/inputs/timer_input.rb
 - lib/fusuma/plugin/manager.rb
 - lib/fusuma/plugin/parsers/libinput_gesture_parser.rb
@@ -79,14 +80,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.1
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Multitouch gestures with libinput driver, Linux