fusuma 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f19305771a0704b1f7294b9b54653f09d7d4f6153ffbdd19a6c23a753870b09
-  data.tar.gz: 3b6c9addcda816e7379e69bb258bd11f091ea39fbae37fc8e0ef4c9ca4b7dff7
+  metadata.gz: e9b2c355ba50b2c62cf23f7c8975d50485710a67b76ffe5a904f67a043c0cac4
+  data.tar.gz: 655c8dcbc527e11a2a8883391ec3970af2081285d54332da975ddd8015117186
 SHA512:
-  metadata.gz: 422dc7e58b8db650754c4939ec1946456bfdfb0a8e4af33d79a20d88d84190f393952e05e1d086f711fb1ee2e6c415c4ddf6861dba8d94bf84df4f4e0585374f
-  data.tar.gz: 02e75550adfd4a6f3e3d43b4a6326377d5182131bdd9d9f3ff3ca0abcb89888e0bca9eea8551868cc87edb0a706fb9b51ee97cc517e093566c7448729359ded2
+  metadata.gz: 7740116f70ca83b977820801c0c2e4b49cd358d2df040710b1a0fa4c75b10cdb9713f932afb08f543c7ec35ae52f4bd3ab141cdf064914fa0e57d19d49443abb
+  data.tar.gz: c53b8ec89c8aabd9c0d32674345472ca0814a559a99a14eb001a9eaea6447de7ef955bccfa5ee29cb9b9b3dfbcab5bc550afa479b26600e5b6f0a979c29dd53d

data/README.md

@@ -3,7 +3,7 @@
 Fusuma is multitouch gesture recognizer.
 This gem makes your linux able to recognize swipes or pinchs and assign commands to them.
 
-![fusuma_image](https://i.gyazo.com/757fef526310b9d68f68e80eb1e4540f.png)
+![fusuma_image](https://repository-images.githubusercontent.com/69813387/60879a00-166c-11ea-9875-3bf0818c62ec)
 
 襖(Fusuma) means sliding door used to partition off rooms in a Japanese house.
 
@@ -83,7 +83,7 @@ $ sudo pacman -S ruby
 
 #### 3. Install Fusuma
 
-**Note:** By default in Arch Linux, when running ```gem```, gems are installed per-user (into ```~/.gem/ruby/```), instead of system-wide (into ```/usr/lib/ruby/gems/```). This is considered the best way to manage gems on Arch, because otherwise they might interfere with gems installed by Pacman. (From Arch Wiki)
+**Note:** By default in Arch Linux, when running `gem`, gems are installed per-user (into `~/.gem/ruby/`), instead of system-wide (into `/usr/lib/ruby/gems/`). This is considered the best way to manage gems on Arch, because otherwise they might interfere with gems installed by Pacman. (From Arch Wiki)
 
 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)
 
@@ -121,7 +121,7 @@ $ sudo gem update fusuma
 
 ## Customize Gesture Mapping
 
-You can customize the settings for gestures to put and edit `~/.config/fusuma/config.yml`.  
+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
@@ -135,12 +135,15 @@ $ nano ~/.config/fusuma/config.yml # edit config file.
 * `swipe:`
   * support `3:`, `4:` fingers
   * support `left:`, `right:`, `up:`, `down:` directions
+  * support `begin:`, `update:`, `end:` events
 * `pinch:`
   * support `2:`, `3:`, `4:` fingers
   * support `in:`, `out:` directions
+  * support `begin:`, `update:`, `end:` events
 * `rotate:`
   * support `2:`, `3:`, `4:` fingers
   * support `clockwise:`,`counterclockwise:` directions
+  * support `begin:`, `update:`, `end:` events
 
 ### About YAML Basic Syntax
 
@@ -157,7 +160,7 @@ https://github.com/iberianpig/fusuma/wiki/Ubuntu
 swipe:
   3:
     left:
-      command: "xdotool key alt+Right" # History forward 
+      command: "xdotool key alt+Right" # History forward
     right:
       command: "xdotool key alt+Left" # History back
     up:
@@ -191,6 +194,8 @@ The following wiki pages can be edited by everyone.
 - [POP OS with Cinnamon](https://github.com/iberianpig/fusuma/wiki/POP-OS-with-Cinnamon)
 - [PopOS Default Gnome](https://github.com/iberianpig/fusuma/wiki/PopOS-Default-Gnome)
 - [Ubuntu OS to mimic Mac a little](https://github.com/iberianpig/fusuma/wiki/Ubuntu-OS-to-mimic-Mac-a-little)
+- [3 fingers Drag (OS X Style)](https://github.com/iberianpig/fusuma/wiki/3-fingers-Drag-(OS-X-Style))
+- [3 fingers Alt Tab Switcher(Windows Style)](https://github.com/iberianpig/fusuma/wiki/3-fingers-Alt-Tab-Switcher(Windows-Style))
 
 If you have a nice configuration, please share `~/.config/fusuma/config.yml` with everyone.
 
@@ -208,19 +213,19 @@ If the swipe's interval is `0.5`, shorten swipe-interval by half to recognize a
 
 ```yaml
 swipe:
-  3: 
-    left: 
+  3:
+    left:
       command: 'xdotool key alt+Right' # threshold: 0.5, interval: 0.75
       threshold: 0.5
-    right: 
+    right:
       command: 'xdotool key alt+Left' # threshold: 0.5, interval: 0.75
       threshold: 0.5
-    up: 
+    up:
       command: 'xdotool key super' # threshold: 1, interval: 0.75
-    down: 
+    down:
       command: 'xdotool key super' # threshold: 1, interval: 0.75
 pinch:
-  2: 
+  2:
     in:
       command: "xdotool keydown ctrl click 4 keyup ctrl" # threshold: 0.5, interval: 0.5
     out:
@@ -234,7 +239,7 @@ interval:
   pinch: 0.5
 ```
 
-There are three priorities of `threshold:` and `interval:`.  
+There are three priorities of `threshold:` and `interval:`.
 The individual `threshold:` and `interval:` settings (under "direction") have a higher priority than the global one (under "root")
 
 1. child elements in the direction (left/right/down/up → threshold/interval)
@@ -280,7 +285,7 @@ swipe:
 - `xte`
   - [xte(1) - Linux man page](https://linux.die.net/man/1/xte)
   - install with `sudo apt xautomation`
-  
+
 - [ydotool](https://github.com/ReimuNotMoe/ydotool)
   - Wayland compatible
   - Needs more maintainers.
@@ -292,7 +297,6 @@ swipe:
 - `-d`, `--daemon` : Daemonize process
 - `-l`, `--list-devices` : List available devices
 - `-v`, `--verbose` : Show details about the results of running fusuma
-- `--device="Device name"` : Open the given device only (DEPRECATED)
 - `--version` : Show fusuma version
 
 ### Specify touchpads by device name
@@ -322,7 +326,7 @@ Following features are provided as plugins.
 - Features for specific Linux distributions
 - Setting different gestures per applications
 
-### Installation of fusuma plugins
+### Installation of Fusuma 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).
 
@@ -340,7 +344,7 @@ Fusuma plugins are provided with the `fusuma-plugin-XXXXX` naming convention and
 
 ## Tutorial Video
 
-[![Multitouch Touchpad Gestures in Linux with Fusuma](http://img.youtube.com/vi/bn11Iwvf29I/0.jpg)](http://www.youtube.com/watch?v=bn11Iwvf29I "Multitouch Touchpad Gestures in Linux with Fusuma")  
+[![Multitouch Touchpad Gestures in Linux with Fusuma](http://img.youtube.com/vi/bn11Iwvf29I/0.jpg)](http://www.youtube.com/watch?v=bn11Iwvf29I "Multitouch Touchpad Gestures in Linux with Fusuma")
 [Multitouch Touchpad Gestures in Linux with Fusuma](http://www.youtube.com/watch?v=bn11Iwvf29I) by [Eric Adams](https://www.youtube.com/user/igster75)
 
 ## Support
@@ -349,7 +353,7 @@ 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.
 
-- [GitHub Sponsors](https://github.com/sponsors/iberianpig) (Zero fee!)
+- [GitHub Sponsors](https://github.com/sponsors/iberianpig)
 - [Patreon](https://www.patreon.com/iberianpig)
 
 ## Contributing

data/lib/fusuma.rb

@@ -142,19 +142,26 @@ module Fusuma
       end
       main_events.sort_by! { |e| e.record.trigger_priority }
 
-      condition = nil
+      matched_condition = nil
       matched_context = nil
       event = main_events.find do |main_event|
         matched_context = Config::Searcher.find_context(request_context) do
-          condition, index_record = Config::Searcher.find_condition do
+          matched_condition, modified_record = Config::Searcher.find_condition do
             main_event.record.merge(records: modifiers.map(&:record))
           end
-          main_event if index_record
+          if matched_condition && modified_record
+            main_event.record = modified_record
+          else
+            matched_condition, = Config::Searcher.find_condition do
+              Config.search(main_event.record.index) &&
+                Config.find_execute_key(main_event.record.index)
+            end
+          end
         end
       end
       return if event.nil?
 
-      [condition, matched_context, event]
+      [matched_condition, matched_context, event]
     end
 
     # @param event [Plugin::Events::Event]

data/lib/fusuma/config.rb

@@ -84,7 +84,7 @@ module Fusuma
       end.flatten
 
       execute_params = search(index)
-      return if execute_params.nil?
+      return if execute_params.nil? || !execute_params.is_a?(Hash)
 
       @execute_keys.find { |k| execute_params.keys.include?(k) }
     end

data/lib/fusuma/config/searcher.rb

@@ -67,8 +67,7 @@ module Fusuma
 
       # next locations' candidates sorted by priority
       #  1. look up location with key
-      #  2. fallback to other key
-      #  3. skip the key and go to child location
+      #  2. skip the key and go to child location
       def next_location_cadidates(location, key)
         [
           location[key.symbol],

data/lib/fusuma/environment.rb

@@ -20,7 +20,7 @@ module Fusuma
         libinput_command = Plugin::Inputs::LibinputCommandInput.new.command
         MultiLogger.info "Fusuma: #{VERSION}"
         MultiLogger.info "libinput: #{libinput_command.version}"
-        MultiLogger.info "ruby #{ RUBY_VERSION }p#{ RUBY_PATCHLEVEL }"
+        MultiLogger.info "ruby #{RUBY_VERSION}p#{RUBY_PATCHLEVEL}"
         MultiLogger.info "OS: #{`uname -rsv`}".strip
         MultiLogger.info "Distribution: #{`cat /etc/issue`}".strip
         MultiLogger.info "Desktop session: #{`echo $DESKTOP_SESSION $XDG_SESSION_TYPE`}".strip

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

@@ -8,7 +8,7 @@ module Fusuma
       # manage events and generate command
       class TimerBuffer < Buffer
         DEFAULT_SOURCE = 'timer_input'
-        DEFAULT_SECONDS_TO_KEEP = 60
+        DEFAULT_SECONDS_TO_KEEP = 3
 
         def config_param_types
           {
@@ -31,8 +31,6 @@ module Fusuma
           @events.each do |e|
             break if current_time - e.time < @seconds_to_keep
 
-            MultiLogger.debug("#{self.class.name}##{__method__}")
-
             @events.delete(e)
           end
         end

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

@@ -15,7 +15,7 @@ module Fusuma
         # @return [Array<Symbol>]
         def execute_keys
           # [name.split('Executors::').last.underscore.gsub('_executor', '').to_sym]
-          raise NotImplementedError, "override #{name}##{__method__}"
+          raise NotImplementedError, "override #{self.class.name}##{__method__}"
         end
 
         # check executable

data/lib/fusuma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fusuma
-  VERSION = '2.0.4'
+  VERSION = '2.0.5'
 end

data/spec/lib/config/searcher_spec.rb

@@ -7,80 +7,162 @@ require './lib/fusuma/config/searcher'
 # spec for Config
 module Fusuma
   RSpec.describe Config::Searcher do
-    let(:keymap) do
-      {
-        'swipe' => {
-          3 => {
-            'left' => { 'command' => 'alt+Left' },
-            'right' => { 'command' => 'alt+Right' }
-          },
-          4 => {
-            'left' => { 'command' => 'super+Left' },
-            'right' => { 'command' => 'super+Right' }
-          }
-        },
-        'pinch' => {
-          'in' => { 'command' => 'ctrl+plus' },
-          'out' => { 'command' => 'ctrl+minus' }
-        }
-      }
-    end
+    around do |example|
+      ConfigHelper.load_config_yml = <<~CONFIG
+        swipe:
+          3:
+            left:
+              command: 'alt+Left'
+            right:
+              command: 'alt+Right'
+          4:
+            left:
+              command: 'super+Left'
+            right:
+              command: 'super+Right'
+        pinch:
+          in:
+            command: 'ctrl+plus'
+          out:
+            command: 'ctrl+minus'
+      CONFIG
 
-    let(:keymap_without_finger) do
-      {
-        'swipe' => {
-          'left' => { 'command' => 'alt+Left' }
-        }
-      }
-    end
+      example.run
 
-    describe '.custom_path=' do
-      before { Singleton.__init__(Config) }
-      it 'should reload keymap file' do
-        keymap = Config.instance.keymap
-        Config.custom_path = './spec/lib/dummy_config.yml'
-        custom_keymap = Config.instance.keymap
-        expect(keymap).not_to eq custom_keymap
-      end
+      ConfigHelper.clear_config_yml
     end
 
     describe '.search' do
       let(:index) { nil }
-      subject { Config::Searcher.new.search(index, location: keymap.deep_symbolize_keys) }
+      let(:location) { Config.instance.keymap[0] }
+      let(:search) { Config::Searcher.new.search(index, location: location) }
       context 'index correct order' do
         let(:index) { Config::Index.new %w[pinch in command] }
-        it { is_expected.to eq 'ctrl+plus' }
+        it { expect(Config::Searcher.new.search(index, location: location)).to eq 'ctrl+plus' }
       end
 
-      context 'index include skippable key' do
-        let(:index) do
-          Config::Index.new [
-            Config::Index::Key.new('pinch'),
-            Config::Index::Key.new(2, skippable: true),
-            Config::Index::Key.new('out'),
-            Config::Index::Key.new('command')
-          ]
-        end
-        it { expect(Config::Searcher.skip { subject }).to eq 'ctrl+minus' }
+      context 'index incorrect order' do
+        let(:index) { Config::Index.new %w[in pinch 2 command] }
+        it { expect(Config::Searcher.new.search(index, location: location)).not_to eq 'ctrl+plus' }
       end
 
-      context 'index include skippable key at first' do
-        let(:index) do
-          Config::Index.new [
-            Config::Index::Key.new(:hoge, skippable: true),
-            Config::Index::Key.new(:fuga, skippable: true),
-            Config::Index::Key.new('pinch'),
-            Config::Index::Key.new('in'),
-            Config::Index::Key.new(:piyo, skippable: true),
-            Config::Index::Key.new('command')
-          ]
+      context 'with Skip condtions' do
+        context 'when index includes skippable key' do
+          let(:index) do
+            Config::Index.new [
+              Config::Index::Key.new('pinch'),
+              Config::Index::Key.new(2, skippable: true),
+              Config::Index::Key.new('out'),
+              Config::Index::Key.new('command')
+            ]
+          end
+          it 'detects ctrl+minus with skip' do
+            condition, value = Config::Searcher.find_condition do
+              Config::Searcher.new.search(index, location: location)
+            end
+            expect([condition, value]).to eq([:skip, 'ctrl+minus'])
+          end
         end
-        it { expect(Config::Searcher.skip { subject }).to eq 'ctrl+plus' }
-      end
 
-      context 'index incorrect order' do
-        let(:index) { Config::Index.new %w[in pinch 2 command] }
-        it { is_expected.not_to eq 'ctrl+plus' }
+        context 'when index includes skippable key at first' do
+          let(:index) do
+            Config::Index.new [
+              Config::Index::Key.new(:hoge, skippable: true),
+              Config::Index::Key.new(:fuga, skippable: true),
+              Config::Index::Key.new('pinch'),
+              Config::Index::Key.new('in'),
+              Config::Index::Key.new(:piyo, skippable: true),
+              Config::Index::Key.new('command')
+            ]
+          end
+          it 'detects ctrl+plus with skip' do
+            condition, value = Config::Searcher.find_condition do
+              Config::Searcher.new.search(index, location: location)
+            end
+            expect([condition, value]).to eq([:skip, 'ctrl+plus'])
+          end
+        end
+
+        context 'with begin/update/end' do
+          around do |example|
+            ConfigHelper.load_config_yml = <<~CONFIG
+              swipe:
+                3:
+                  begin:
+                    command: 'echo begin'
+                  update:
+                    command: 'echo update'
+                  end:
+                    command: 'echo end'
+                    keypress:
+                      LEFTCTRL:
+                        command: 'echo end+ctrl'
+            CONFIG
+
+            example.run
+
+            ConfigHelper.clear_config_yml
+          end
+
+          context 'without keypress' do
+            let(:index) do
+              Config::Index.new [
+                Config::Index::Key.new(:swipe),
+                Config::Index::Key.new(3),
+                Config::Index::Key.new('left', skippable: true),
+                Config::Index::Key.new('end'),
+                Config::Index::Key.new('command')
+              ]
+            end
+
+            it 'detects with skip' do
+              condition, value = Config::Searcher.find_condition do
+                Config::Searcher.new.search(index, location: location)
+              end
+              expect([condition, value]).to eq([:skip, 'echo end'])
+            end
+          end
+          context 'with keypress' do
+            context 'with valid key existing in config.yml' do
+              let(:index) do
+                Config::Index.new [
+                  Config::Index::Key.new(:swipe),
+                  Config::Index::Key.new(3),
+                  Config::Index::Key.new('left', skippable: true),
+                  Config::Index::Key.new('end'),
+                  Config::Index::Key.new('keypress', skippable: true),
+                  Config::Index::Key.new('LEFTCTRL', skippable: true),
+                  Config::Index::Key.new('command')
+                ]
+              end
+              it 'detects end+ctrl with skip' do
+                condition, value = Config::Searcher.find_condition do
+                  Config::Searcher.new.search(index, location: location)
+                end
+                expect([condition, value]).to eq([:skip, 'echo end+ctrl'])
+              end
+            end
+            context 'with non-existing key not existing in config.yml' do
+              let(:index) do
+                Config::Index.new [
+                  Config::Index::Key.new(:swipe),
+                  Config::Index::Key.new(3),
+                  Config::Index::Key.new('up', skippable: true),
+                  Config::Index::Key.new('end'),
+                  Config::Index::Key.new('keypress', skippable: true),
+                  Config::Index::Key.new('LEFTSHIFT', skippable: true), # Invalid key
+                  Config::Index::Key.new('command')
+                ]
+              end
+              it 'detects end with skip (fallback to no keypress)' do
+                condition, value = Config::Searcher.find_condition do
+                  Config::Searcher.new.search(index, location: location)
+                end
+                expect([condition, value]).to eq([:skip, 'echo end'])
+              end
+            end
+          end
+        end
       end
     end
 

data/spec/lib/config_spec.rb

@@ -25,14 +25,6 @@ module Fusuma
       }
     end
 
-    let(:keymap_without_finger) do
-      {
-        'swipe' => {
-          'left' => { 'command' => 'alt+Left' }
-        }
-      }
-    end
-
     describe '.custom_path=' do
       before { Singleton.__init__(Config) }
       it 'should reload keymap file' do

data/spec/lib/plugin/detectors/detector_spec.rb

@@ -27,7 +27,7 @@ module Fusuma
 
           example.run
 
-          Config.custom_path = nil
+          ConfigHelper.clear_config_yml
         end
 
         describe '#detect' do

data/spec/lib/plugin/executors/executor_spec.rb

@@ -13,20 +13,24 @@ module Fusuma
       RSpec.describe Executor do
         before { @executor = Executor.new }
 
+        describe '#execute_key' do
+          it { expect { @executor.execute_keys }.to raise_error(NotImplementedError) }
+        end
+
         describe '#execute' do
-          it do
-            expect { @executor.execute('dummy') }.to raise_error(NotImplementedError)
-          end
+          it { expect { @executor.execute('dummy') }.to raise_error(NotImplementedError) }
         end
 
         describe '#executable?' do
-          it do
-            expect { @executor.executable?('dummy') }.to raise_error(NotImplementedError)
-          end
+          it { expect { @executor.executable?('dummy') }.to raise_error(NotImplementedError) }
         end
       end
 
       class DummyExecutor < Executor
+        def execute_keys
+          [:dummy]
+        end
+
         def execute(event)
           index = Config::Index.new([*event.record.index.keys, :dummy])
           content = Config.search(index)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - iberianpig
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-24 00:00:00.000000000 Z
+date: 2021-05-21 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