fusuma 2.5.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9368eba481cbc496fb561cb449ec99c6b5f1eff8b4c8c4a9c8d61b4e7d5b4cf8
-  data.tar.gz: 3bea9acc54d3e2061f391ec282f9327ca2b3fd70463fa5f2394063a980b20613
+  metadata.gz: 8ff7ea9fcd08ba0c48e1c08d9eceeb4a1e30684a0616f37fef6f67a3e035c005
+  data.tar.gz: c68adc10a8e2b7fb5396c7c789f941b13bacc9d60d6d669a7d8004c773503d75
 SHA512:
-  metadata.gz: 2af60b07cfa18ca3b3d13eedf9b0271ff5bfdea37776e66a51e59eb33ea2e6bd35fe1fdc4724738ca3ecec37c7a6811c202c4277bf1e4ff341fda81e8fdb9f58
-  data.tar.gz: 4583ee8007e36e364658f02a42d5f447adb947408e690cb0f554c004672869f0304e2e674335aebc2d9a267abcb01cbe2f559845e604d4acc945620d7fada1a7
+  metadata.gz: 46fdbcb0b697ba9000e55de86a9550d783c81c6407f13ebe82375c2b741341a591bcf45fe6c707247a9a2017e4f3ca4834111af551a4a65001cc7e944487b28e
+  data.tar.gz: e0e579b0d73ea237202ae17f641c07a1ed7587a771c71bfe12d55edec62b3d9e3281fd010f646e6e7077a6245e0365d0ed73c7042528a8c8c5ac72bbeed956de

data/README.md

@@ -1,4 +1,5 @@
-# Fusuma [![Gem Version](https://badge.fury.io/rb/fusuma.svg)](https://badge.fury.io/rb/fusuma) [![Build Status](https://github.com/iberianpig/fusuma/actions/workflows/ubuntu.yml/badge.svg)](https://github.com/iberianpig/fusuma/actions/workflows/ubuntu.yml)
+# Fusuma
+![Gem](https://img.shields.io/gem/v/fusuma?color=brightgreen) [![Build Status](https://github.com/iberianpig/fusuma/actions/workflows/main.yml/badge.svg)](https://github.com/iberianpig/fusuma/actions/workflows/main.yml)
 
 Fusuma is multitouch gesture recognizer.
 This gem makes your linux able to recognize swipes or pinchs and assign commands to them.
@@ -21,23 +22,28 @@ This gem makes your linux able to recognize swipes or pinchs and assign commands
 
 **IMPORTANT**: You **MUST** be a member of the **INPUT** group to read touchpad by Fusuma.
 
-```bash
+```sh
 sudo gpasswd -a $USER input
 ```
 
 Then, You apply the change with no logout or reboot.
 
-```bash
+```sh
 newgrp input
 ```
 
+**IMPORTANT**: This makes `/dev/input/` readable, so if that's an issue for you for some reason (like for privacy- or securityconcerns etc. or if it causes other parts of your OS to misbehave), **consider this your heads-up.** 
+
+<details>
+<summary>For Debian Based Distros (Ubuntu, Debian, Mint, Pop!OS)</summary>
+
 ### For Debian Based Distros (Ubuntu, Debian, Mint, Pop!OS)
 
 #### 1. Install libinput-tools
 
 You need `libinput` release 1.0 or later.
 
-```bash
+```sh
 sudo apt-get install libinput-tools
 ```
 
@@ -45,13 +51,13 @@ sudo apt-get install libinput-tools
 
 Fusuma runs in Ruby, so you must install it first.
 
-```bash
+```sh
 sudo apt-get install ruby
 ```
 
 #### 3. Install Fusuma
 
-```bash
+```sh
 sudo gem install fusuma
 ```
 
@@ -59,26 +65,31 @@ sudo gem install fusuma
 
 For sending shortcuts:
 
-```bash
+```sh
 sudo apt-get install xdotool
 ```
 
+</details>
+
+<details>
+<summary> For Arch Based Distros (Manjaro, Arch) </summary>
+
 ### For Arch Based Distros (Manjaro, Arch)
 
 #### 1. Install libinput.
 
 You need `libinput` release 1.0 or later. This is most probably installed by default on Manjaro
 
-```z-h
-sudo pacman -S libinput
+```sh
+sudo pacman -Syu libinput
 ```
 
 #### 2. Install Ruby
 
 Fusuma runs in Ruby, so you must install it first.
 
-```zsh
-sudo pacman -S ruby
+```sh
+sudo pacman -Syu ruby
 ```
 
 #### 3. Install Fusuma
@@ -87,7 +98,7 @@ sudo pacman -S ruby
 
 To install gems system-wide, see any of the methods listed on [Arch Wiki](https://wiki.archlinux.org/index.php/ruby#Installing_gems_system-wide)
 
-```zsh
+```sh
 sudo gem install fusuma
 ```
 
@@ -95,9 +106,19 @@ sudo gem install fusuma
 
 For sending shortcuts:
 
-```zsh
-sudo pacman -S xdotool
+```sh
+sudo pacman -Syu xdotool
 ```
+**For the truly lazy people:** As with pretty much anything else available as Open-Source-Software, you can install Fusuma via a package from the AUR. As off time of writing (March 2023), the package you would want is called `ruby-fusuma`.
+
+Please keep in mind that this community-built package is NOT officially supported here and while it might do the job, it is not the intended way to install.
+Installing Fusuma this way means that if things do not work as intended during or after the installation, you are on your own.
+So please do not bombard the Issues-Page here on Github if Fusuma isn't working correctly after installing it via the AUR.
+Fusuma's plugins as listed below here in this Readme can be installed as optional dependencies also via the AUR, namescheme being `ruby-fusuma-replacewithnameofplugin`.
+</details>
+
+<details>
+<summary>For Fedora</summary>
 
 ### For Fedora
 
@@ -105,7 +126,7 @@ sudo pacman -S xdotool
 
 You need `libinput` release 1.0 or later.
 
-```bash
+```sh
 sudo dnf install libinput
 ```
 
@@ -113,13 +134,13 @@ sudo dnf install libinput
 
 Fusuma runs in Ruby, so you must install it first.
 
-```bash
+```sh
 sudo dnf install ruby
 ```
 
 #### 3. Install Fusuma
 
-```bash
+```sh
 sudo gem install fusuma
 ```
 
@@ -127,27 +148,28 @@ sudo gem install fusuma
 
 For sending shortcuts:
 
-```bash
+```sh
 sudo dnf install xdotool
 ```
+</details>
 
 ### Touchpad not working in GNOME
 
 Ensure the touchpad events are being sent to the GNOME desktop by running the following command:
 
-```bash
+```sh
 gsettings set org.gnome.desktop.peripherals.touchpad send-events enabled
 ```
 
 ## Usage
 
-```bash
+```sh
 fusuma
 ```
 
 ## Update
 
-```bash
+```sh
 sudo gem update fusuma
 ```
 
@@ -156,7 +178,7 @@ sudo gem update fusuma
 You can customize the settings for gestures to put and edit `~/.config/fusuma/config.yml`.
 **NOTE: You will need to create the `~/.config/fusuma` directory if it doesn't exist yet.**
 
-```bash
+```sh
 mkdir -p ~/.config/fusuma        # create config directory
 nano ~/.config/fusuma/config.yml # edit config file.
 ```
@@ -322,7 +344,6 @@ swipe:
 #### Alternatives to xdotool
 
 - [fusuma-plugin-sendkey](https://github.com/iberianpig/fusuma-plugin-sendkey)
-
   - Emulates keyboard events
   - Low latency
   - Wayland compatible
@@ -334,7 +355,8 @@ swipe:
 - [ydotool](https://github.com/ReimuNotMoe/ydotool)
   - Wayland compatible
   - Needs more maintainers.
-  - Requires only replacing `xdotool` with `ydotool` in fusuma conf.
+
+
 
 ## Options
 
@@ -376,22 +398,22 @@ Following features are provided as plugins.
 
 Fusuma plugins are provided with the `fusuma-plugin-XXXXX` naming convention and hosted on [RubyGems](https://rubygems.org/search?utf8=%E2%9C%93&query=fusuma-plugins).
 
-| Name                                                                               | Version                                                               | About                                         |
-| ---------------------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------- |
-| [fusuma-plugin-sendkey](https://github.com/iberianpig/fusuma-plugin-sendkey)       | ![Gem Version](https://badge.fury.io/rb/fusuma-plugin-sendkey.svg)    | Emulates keyboard events                      |
-| [fusuma-plugin-wmctrl](https://github.com/iberianpig/fusuma-plugin-wmctrl)         | ![Gem Version](https://badge.fury.io/rb/fusuma-plugin-wmctrl.svg)     | Manages Window and Workspace                  |
-| [fusuma-plugin-keypress](https://github.com/iberianpig/fusuma-plugin-keypress)     | ![Gem Version](https://badge.fury.io/rb/fusuma-plugin-keypress.svg)   | Detects gestures while pressing multiple keys |
-| [fusuma-plugin-tap](https://github.com/iberianpig/fusuma-plugin-tap)               | ![Gem Version](https://badge.fury.io/rb/fusuma-plugin-tap.svg)        | Detects Tap and Hold gestures                 |
-| [fusuma-plugin-appmatcher](https://github.com/iberianpig/fusuma-plugin-appmatcher) | ![Gem Version](https://badge.fury.io/rb/fusuma-plugin-appmatcher.svg) | Configure app-specific gestures               |
+| Name                                                                               | Version                                                                         | About                                                        |
+| ---                                                                                | ---                                                                             | ---                                                          |
+| [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                              |
 
 
 ### Installation of Fusuma plugins
 
-```bash
+```sh
 # install fusuma-plugin-XXXX
 sudo gem install fusuma-plugin-XXXXX`
 ```
-```bash
+```sh
 # update
 sudo gem list fusuma-plugin- | cut -d' ' -f1 | xargs --no-run-if-empty sudo gem update
 ```
@@ -408,7 +430,6 @@ 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.
 
 - [GitHub Sponsors](https://github.com/sponsors/iberianpig)
-- [Patreon](https://www.patreon.com/iberianpig)
 
 ## Contributing
 

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

@@ -6,17 +6,19 @@ module Fusuma
     # index for config.yml
     class Index
       def initialize(keys)
-        @keys = case keys
+        @count = 0
+        case keys
         when Array
-          keys.map do |key|
-            if key.is_a? Key
-              key
-            else
-              Key.new(key)
-            end
-          end
+          @keys = []
+          @cache_key = keys.map do |key|
+            key = Key.new(key) if !key.is_a? Key
+            @keys << key
+            key.symbol
+          end.join(",")
         else
-          [Key.new(keys)]
+          key = Key.new(keys)
+          @cache_key = key.symbol
+          @keys = [key]
         end
       end
 
@@ -24,36 +26,11 @@ module Fusuma
         @keys.map(&:inspect)
       end
 
-      attr_reader :keys
-
-      def cache_key
-        case @keys
-        when Array
-          @keys.map(&:symbol).join(",")
-        when Key
-          @keys.symbol
-        else
-          raise "invalid keys"
-        end
-      end
-
-      # @return [Index]
-      def with_context
-        keys = @keys.map do |key|
-          next if Searcher.skip? && key.skippable
-
-          if Searcher.fallback? && key.fallback
-            key.fallback
-          else
-            key
-          end
-        end
-        self.class.new(keys.compact)
-      end
+      attr_reader :keys, :cache_key
 
       # Keys in Index
       class Key
-        def initialize(symbol_word, skippable: false, fallback: nil)
+        def initialize(symbol_word, skippable: false)
           @symbol = begin
             symbol_word.to_sym
           rescue
@@ -61,21 +38,17 @@ module Fusuma
           end
 
           @skippable = skippable
-
-          @fallback = begin
-            fallback.to_sym
-          rescue
-            fallback
-          end
         end
 
         def inspect
-          skip_marker = @skippable && Searcher.skip? ? "(skip)" : ""
-          fallback_marker = @fallback && Searcher.fallback? ? "(fallback)" : ""
-          "#{@symbol}#{skip_marker}#{fallback_marker}"
+          if @skippable
+            "#{@symbol}(skippable)"
+          else
+            @symbol.to_s
+          end
         end
 
-        attr_reader :symbol, :skippable, :fallback
+        attr_reader :symbol, :skippable
       end
     end
   end

data/lib/fusuma/config/searcher.rb

@@ -6,7 +6,7 @@ module Fusuma
     # Search config.yml
     class Searcher
       def initialize
-        @cache = nil
+        @cache = {}
       end
 
       # @param index [Index]
@@ -36,10 +36,11 @@ module Fusuma
 
         return search(index, location: location[0]) if context == {}
 
-        new_location = location.find do |conf|
-          search(index, location: conf) if conf[:context] == context
+        value = nil
+        location.find do |conf|
+          value = search(index, location: conf) if conf[:context] == context
         end
-        search(index, location: new_location)
+        value
       end
 
       # @param index [Index]
@@ -48,13 +49,12 @@ module Fusuma
       # @return [Hash]
       # @return [Object]
       def search_with_cache(index, location:)
-        cache([index.cache_key, Searcher.context, Searcher.skip?, Searcher.fallback?]) do
+        cache([index.cache_key, Searcher.context]) do
           search_with_context(index, location: location, context: Searcher.context)
         end
       end
 
       def cache(key)
-        @cache ||= {}
         key = key.join(",") if key.is_a? Array
         if @cache.key?(key)
           @cache[key]
@@ -71,36 +71,12 @@ module Fusuma
       def next_location_cadidates(location, key)
         [
           location[key.symbol],
-          Searcher.skip? && key.skippable && location
+          key.skippable && location
         ].compact
       end
 
       class << self
-        # @return [Hash]
-        def conditions(&block)
-          {
-            nothing: -> { block.call },
-            skip: -> { Config::Searcher.skip { block.call } }
-          }
-        end
-
-        # Execute block with specified conditions
-        # @param conidtion [Symbol]
-        # @return [Object]
-        def with_condition(condition, &block)
-          conditions(&block)[condition].call
-        end
-
-        # Execute block with all conditions
-        # @return [Array<Symbol, Object>]
-        def find_condition(&block)
-          conditions(&block).find do |c, l|
-            result = l.call
-            return [c, result] if result
-
-            nil
-          end
-        end
+        attr_reader :context
 
         # Search with context from load_streamed Config
         # @param context [Hash]
@@ -112,52 +88,84 @@ 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. complete match config[:context] == request_context
-          # 2. partial match config[:context] =~ request_context
-          # 3. no context
+          # 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.call }
+            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?
 
               next unless config[:context].all? { |k, v| request_context[k] == v }
-              return config[:context] if with_context(config[:context]) { block.call }
+              return config[:context] if with_context(config[:context], &block)
             end
+            nil
           end
-          return {} if with_context({}) { block.call }
-        end
-
-        attr_reader :context
-
-        def fallback?
-          @fallback
         end
 
-        def skip?
-          @skip
-        end
+        # 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)
 
-        # switch context for fallback
-        def fallback(&block)
-          @fallback = true
-          result = block.call
-          @fallback = false
-          result
-        end
+            if config[:context][:plugin_defaults] == request_context[:plugin_defaults]
+              complete_match_context = config[:context]
+              next
+            end
 
-        def skip(&block)
-          @skip = true
-          result = block.call
-          @skip = false
-          result
+            return config[:context] if with_context(config[:context], &block)
+          end
+          complete_match_context
         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