fusuma 2.0.0.pre2 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f7ab066b275d3d5bdf59d18a948d297d0e164f71d0611e6f999c71d962a8f6d
-  data.tar.gz: f92ff70084e6b98482236b67b2f2c68d7424f7cb8ff1e9ad6b61f4a7d4bea244
+  metadata.gz: 8f19305771a0704b1f7294b9b54653f09d7d4f6153ffbdd19a6c23a753870b09
+  data.tar.gz: 3b6c9addcda816e7379e69bb258bd11f091ea39fbae37fc8e0ef4c9ca4b7dff7
 SHA512:
-  metadata.gz: 885b781c3ec389cc6e37a68eb0799044e8792587145875d7c3facb59dc3a003cd53c4beb9d2a539f534f4947b2a5cf4d43442a9d3a0dba929744881feac7607c
-  data.tar.gz: a79c1f4390694af343cb98901f30916c32642ff5318181a8191c855997eff64aea3dc4a88f02b51a7bfb2565ac7037965bb2816b24141eab6bcd6a23f9ce04dc
+  metadata.gz: 422dc7e58b8db650754c4939ec1946456bfdfb0a8e4af33d79a20d88d84190f393952e05e1d086f711fb1ee2e6c415c4ddf6861dba8d94bf84df4f4e0585374f
+  data.tar.gz: 02e75550adfd4a6f3e3d43b4a6326377d5182131bdd9d9f3ff3ca0abcb89888e0bca9eea8551868cc87edb0a706fb9b51ee97cc517e093566c7448729359ded2

data/README.md

@@ -330,12 +330,13 @@ Fusuma plugins are provided with the `fusuma-plugin-XXXXX` naming convention and
 
 ### Available plugins
 
-| Name                                                                           | About                                         |
-| ------------------------------------------------------------------------------ | --------------------------------------------- |
-| [fusuma-plugin-sendkey](https://github.com/iberianpig/fusuma-plugin-sendkey)   | Emulates keyboard events                      |
-| [fusuma-plugin-wmctrl](https://github.com/iberianpig/fusuma-plugin-wmctrl)     | Manages Window and Workspace                  |
-| [fusuma-plugin-keypress](https://github.com/iberianpig/fusuma-plugin-keypress) | Detects gestures while pressing multiple keys |
-| [fusuma-plugin-tap](https://github.com/iberianpig/fusuma-plugin-tap)           | Detects Tap and Hold gestures                 |
+| 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               |
 
 ## Tutorial Video
 

data/fusuma.gemspec

@@ -10,14 +10,13 @@ Gem::Specification.new do |spec|
   spec.authors       = ['iberianpig']
   spec.email         = ['yhkyky@gmail.com']
 
-  spec.summary       = 'Multitouch gestures with libinput driver on X11, Linux'
+  spec.summary       = 'Multitouch gestures with libinput driver, Linux'
   spec.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 on Github(https://github.com/iberianpig/fusuma#installation).'
   spec.homepage      = 'https://github.com/iberianpig/fusuma'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
+  spec.files          = Dir['{bin,lib,exe}/**/*', 'LICENSE*', 'README*', '*.gemspec']
+  spec.test_files     = Dir['{test,spec,features}/**/*']
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
@@ -25,5 +24,4 @@ Gem::Specification.new do |spec|
 
   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.add_dependency 'posix-spawn'
 end

data/lib/fusuma/config/searcher.rb

@@ -32,6 +32,8 @@ module Fusuma
       end
 
       def search_with_context(index, location:, context:)
+        return nil if location.nil?
+
         return search(index, location: location[0]) if context == {}
 
         new_location = location.find do |conf|

data/lib/fusuma/device.rb

@@ -36,9 +36,9 @@ module Fusuma
       # sort devices by capabilities of gesture
       # @return [Array]
       def all
-        @all ||= fetch_devices.sort_by do |d|
-          d.capabilities.match(/gesture/).to_s
-        end
+        @all ||= fetch_devices.partition do |d|
+          d.capabilities.match?(/gesture/)
+        end.flatten
       end
 
       # @raise [SystemExit]

data/lib/fusuma/environment.rb

@@ -20,6 +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 "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/libinput_command.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'posix/spawn'
+require 'open3'
 
 module Fusuma
   # Execute libinput command
@@ -33,20 +33,20 @@ module Fusuma
     def list_devices(&block)
       cmd = list_devices_command
       MultiLogger.debug(list_devices: cmd)
-      p, i, o, e = POSIX::Spawn.popen4(cmd)
+      i, o, e, _w = Open3.popen3(cmd)
+      MultiLogger.error(e.read) if o.eof?
       i.close
+      e.close
       o.each(&block)
-    ensure
-      [i, o, e].each { |io| io.close unless io.closed? }
-      Process.waitpid(p)
     end
 
-    # @return [Integer, IO] return a latest line libinput debug-events
-    def debug_events
-      @debug_events = begin
-        p, i, o, _e = POSIX::Spawn.popen4(debug_events_with_options)
-        i.close
-        [p, o]
+    # @return [Integer] return a latest line libinput debug-events
+    def debug_events(writer)
+      @debug_events ||= begin
+        pid = Process.spawn(debug_events_with_options, out: writer,
+                                                       in: '/dev/null')
+        Process.detach(pid)
+        pid
       end
     end
 
@@ -60,7 +60,7 @@ module Fusuma
       elsif which('libinput-list-devices')
         'libinput-list-devices --version'
       else
-        MultiLogger.error 'install libinput-tools'
+        MultiLogger.error 'Please install libinput-tools'
         exit 1
       end
     end

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'posix/spawn'
 require_relative './executor'
 
 module Fusuma
@@ -15,18 +14,19 @@ module Fusuma
         end
 
         def execute(event)
-          search_command(event).tap do |command|
-            break unless command
+          command = search_command(event)
 
-            MultiLogger.info(command: command, args: event.record.args)
+          MultiLogger.info(command: command, args: event.record.args)
 
-            additional_env = event.record.args
-                                  .deep_transform_keys(&:to_s)
-                                  .deep_transform_values { |v| (v * args_accel(event)).to_s }
+          accel = args_accel(event)
+          additional_env = event.record.args
+                                .deep_transform_keys(&:to_s)
+                                .deep_transform_values { |v| (v * accel).to_s }
 
-            pid = POSIX::Spawn.spawn(additional_env, command.to_s)
-            Process.detach(pid)
-          end
+          pid = Process.spawn(additional_env, command.to_s)
+          Process.detach(pid)
+        rescue SystemCallError => e
+          MultiLogger.error("#{event.record.index.keys}": e.message.to_s)
         end
 
         def executable?(event)

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

@@ -25,6 +25,7 @@ module Fusuma
             warn "#{input.class.name}: #{e}"
             warn 'Send SIGKILL to fusuma processes'
             inputs.reject { |i| i == input }.each do |i|
+              warn "stop process: #{i.class.name.underscore}"
               Process.kill(:SIGKILL, i.pid)
             end
             exit 1

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

@@ -25,8 +25,9 @@ module Fusuma
         # @return [IO]
         def io
           @io ||= begin
-            @pid, io = command.debug_events
-            io
+            reader, writer = create_io
+            @pid = command.debug_events(writer)
+            reader
           end
         end
 
@@ -64,6 +65,12 @@ module Fusuma
         def list_devices_command
           config_params(:'libinput-list-devices')
         end
+
+        private
+
+        def create_io
+          IO.pipe
+        end
       end
     end
   end

data/lib/fusuma/plugin/manager.rb

@@ -21,8 +21,19 @@ module Fusuma
       def require_siblings_from_gems
         search_key = File.join(plugin_dir_name, '*.rb')
         Gem.find_latest_files(search_key).each do |siblings_plugin|
-          if siblings_plugin =~ %r{fusuma-plugin-(.+).*/lib/#{plugin_dir_name}/\1_.+.rb}
+          next unless siblings_plugin =~ %r{fusuma-plugin-(.+).*/lib/#{plugin_dir_name}/\1_.+.rb}
+
+          match_data = siblings_plugin.match(%r{(.*)/(.*)/lib/(.*)})
+          gemspec_path = Dir.glob("#{match_data[1]}/#{match_data[2]}/*.gemspec").first
+          raise "Not Found: #{match_data[1]}/#{match_data[2]}/*.gemspec" unless gemspec_path
+
+          gemspec = Gem::Specification.load(gemspec_path)
+          fusuma_gemspec_path = File.expand_path('../../../fusuma.gemspec', __dir__)
+          fusuma_gemspec = Gem::Specification.load(fusuma_gemspec_path)
+          if gemspec.dependencies.find { |d| d.name == 'fusuma' }&.match?(fusuma_gemspec)
             require siblings_plugin
+          else
+            MultiLogger.warn "#{gemspec.name} #{gemspec.version} is incompatible with running #{fusuma_gemspec.name} #{fusuma_gemspec.version}"
           end
         end
       end

data/lib/fusuma/version.rb

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

data/spec/helpers/config_helper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+require './lib/fusuma/config'
+
+module Fusuma
+  module ConfigHelper
+    module_function
+
+    def load_config_yml=(string)
+      Config.custom_path = Tempfile.open do |temp_file|
+        temp_file.tap { |f| f.write(string) }
+      end
+    end
+
+    def clear_config_yml
+      Config.custom_path = nil
+    end
+  end
+end

data/spec/lib/config/searcher_spec.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require './lib/fusuma/config'
+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
+
+    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
+        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
+    end
+
+    describe '.search' do
+      let(:index) { nil }
+      subject { Config::Searcher.new.search(index, location: keymap.deep_symbolize_keys) }
+      context 'index correct order' do
+        let(:index) { Config::Index.new %w[pinch in command] }
+        it { is_expected.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' }
+      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')
+          ]
+        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' }
+      end
+    end
+
+    describe 'private_method: :cache' do
+      it 'should cache command' do
+        key   = %w[event_type finger direction command].join(',')
+        value = 'shourtcut string'
+        searcher = Config::Searcher.new
+        searcher.send(:cache, key) { value }
+        expect(searcher.send(:cache, key)).to eq value
+      end
+    end
+  end
+end

data/spec/lib/config_spec.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require './lib/fusuma/config'
+
+# spec for Config
+module Fusuma
+  RSpec.describe Config 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
+
+    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
+        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
+    end
+
+    describe '#reload' do
+      before { Singleton.__init__(Config) }
+      it 'set Seacher' do
+        old = Config.instance.searcher
+        Config.instance.reload
+        expect(Config.instance.searcher).not_to eq(old)
+      end
+    end
+
+    describe '#validate' do
+      context 'with valid yaml' do
+        before do
+          string = <<~CONFIG
+            swipe:
+              3:
+                left:
+                  command: echo 'swipe left'
+
+          CONFIG
+          @file_path = Tempfile.open do |temp_file|
+            temp_file.tap { |f| f.write(string) }
+          end
+        end
+
+        it 'should return Hash' do
+          Config.instance.validate(@file_path)
+        end
+      end
+
+      context 'with invalid yaml' do
+        before do
+          string = <<~CONFIG
+            this is not yaml
+          CONFIG
+          @file_path = Tempfile.open do |temp_file|
+            temp_file.tap { |f| f.write(string) }
+          end
+        end
+
+        it 'raise InvalidFileError' do
+          expect { Config.instance.validate(@file_path) }.to raise_error(Config::InvalidFileError)
+        end
+
+        context 'with duplicated key' do
+          before do
+            string = <<~CONFIG
+              pinch:
+                2:
+                  in:
+                    command: "xdotool keydown ctrl click 4 keyup ctrl" # threshold: 0.5, interval: 0.5
+                2:
+                  out:
+                    command: "xdotool keydown ctrl click 5 keyup ctrl" # threshold: 0.5, interval: 0.5
+            CONFIG
+            @file_path = Tempfile.open do |temp_file|
+              temp_file.tap { |f| f.write(string) }
+            end
+          end
+
+          it 'raise InvalidFileError' do
+            expect { Config.instance.validate(@file_path) }.to raise_error(Config::InvalidFileError)
+          end
+        end
+      end
+    end
+  end
+end