fusuma-plugin-keypress 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 958f90d65b6a5bfe120a5462bbfc1d21e01dbdf95d97f279e824a6ad6aafa5a3
-  data.tar.gz: 6d8c96cb5be6b003f00c0d20bc6bf68af693857e82d9ceb87837a1b752678e0f
+  metadata.gz: e4dee24a10fad696ea3f6fd58e02e1c2358f522455bc9ec4aef6bc53b2004d2c
+  data.tar.gz: 3e0016a1d55bc7cb4096c9a77916fa1910e8a81561992255c97b17a8a67d6ddf
 SHA512:
-  metadata.gz: 7be790c59d66696f078c89121f32f9dd61630a0debfe3584899cac8b0ed73d335b2858aca88e7d84b511dcb1cbaf9a0e36ac487300c519f2c5480ac7f16a4040
-  data.tar.gz: 858e05f1aca03e80be587ed315e79717a5c6815336c5b1ef8e1c112603df698be6d3b720853c18f2b200137b8c9eb866907e325032c8727ee6d1ffba368bc07e
+  metadata.gz: 22187a3a208c1d0989eac56c565cf00124920bb141d38f3549743c473c0b42708256c73d6c7603c6776f245a46c3ae6df8f791ba4e51f9c09de47f529b8b008b
+  data.tar.gz: e7f937130567f31bb3b226b3cb502f98fff973aceb21a68813170fa77d0ea80e1e531c5fabf1e0c57e56c463072ed14a1f3e9f28fc5201eca69610cdfea56f5b

data/README.md

@@ -1,4 +1,4 @@
-# Fusuma::Plugin::Keypress [![Gem Version](https://badge.fury.io/rb/fusuma-plugin-keypress.svg)](https://badge.fury.io/rb/fusuma-plugin-keypress) [![Build Status](https://travis-ci.com/iberianpig/fusuma-plugin-keypress.svg?branch=master)](https://travis-ci.com/iberianpig/fusuma-plugin-keypress)
+# Fusuma::Plugin::Keypress [![Gem Version](https://badge.fury.io/rb/fusuma-plugin-keypress.svg)](https://badge.fury.io/rb/fusuma-plugin-keypress) [![Build Status](https://github.com/iberianpig/fusuma-plugin-keypress/actions/workflows/ubuntu.yml/badge.svg)](https://github.com/iberianpig/fusuma-plugin-keypress/actions/workflows/ubuntu.yml)
 
 
 Keyboard + Touchpad combination plugin for [Fusuma](https://github.com/iberianpig/fusuma)
@@ -33,6 +33,7 @@ plugin:
 
 ## Properties
 
+### Keypress
 Add `keypress:` property in `~/.config/fusuma/config.yml`.
 
 Keys following are available for `keypress`.
@@ -80,6 +81,29 @@ plugin:
 * Swipe up/down with four fingers while keypress LEFTMETA and LEFTALT keys to change audio volume.
   - If you want to combine a gesture with two keys, combine modifier keys with `+`
 
+
+## Typing Gesture
+
+`typing:` is a trigger that fires when keys other than modifier keys are pressed. This trigger provides disable-while-typing similar to libinput and syndaemon.
+If you are using a keyremapper such as xkeysnail and libinput's disable-while-typing does not work, try setting it.
+
+It can be placed in the root of yaml and configured as a gesture.
+The following is a configuration that uses xinput to turn off tapping for 0.6 seconds to avoid false touches.
+
+```yaml
+typing: # disable while typing
+  command: |
+    touchpad_id=$(xinput | grep Touchpad | grep -oE "id=[0-9]*" | cut -d"=" -f 2)
+    xinput set-prop $touchpad_id "libinput Tapping Enabled" 0
+    file=/tmp/typing_command_break
+    touch "$file"
+    sleep 0.6
+    [ `find "$file" -mmin +0.01` ] && \
+      xinput set-prop $touchpad_id "libinput Tapping Enabled" 1
+  interval: 0.5
+```
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/iberianpig/fusuma-plugin-keypress. 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/fusuma-plugin-keypress.gemspec

@@ -25,4 +25,7 @@ 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 'fusuma', '~> 2.0'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
 end

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

@@ -1,13 +1,27 @@
 # frozen_string_literal: true
 
+require 'set'
+
 module Fusuma
   module Plugin
     module Detectors
       # Detect KeypressEvent from KeypressBuffer
       class KeypressDetector < Detector
-        SOURCES = ['keypress'].freeze
+        SOURCES = %w[keypress].freeze
         BUFFER_TYPE = 'keypress'
 
+        MODIFIER_KEYS = Set.new(%w[
+                                  CAPSLOCK
+                                  LEFTALT
+                                  LEFTCTRL
+                                  LEFTMETA
+                                  LEFTSHIFT
+                                  RIGHTALT
+                                  RIGHTCTRL
+                                  RIGHTSHIFT
+                                  RIGHTMETA
+                                ])
+
         # Always watch buffers and detect them.
         def watch?
           true
@@ -17,28 +31,59 @@ module Fusuma
         # @return [Event] if event is detected
         # @return [NilClass] if event is NOT detected
         def detect(buffers)
-          buffer = buffers.find { |b| b.type == BUFFER_TYPE }
+          keypress_buffer = find_buffer(buffers)
 
-          return if buffer.empty?
+          return if keypress_buffer.empty?
 
-          records = buffer.events.select { |e| e.record.status == 'pressed' }.map(&:record)
+          codes = pressed_codes(keypress_buffer.events.map(&:record))
 
-          index_record = Events::Records::IndexRecord.new(
-            index: create_index(records: records),
-            position: :surfix
-          )
+          return if codes.empty?
+
+          record = if codes.any? { |code| MODIFIER_KEYS.include?(code) }
+                     Events::Records::IndexRecord.new(index: create_index(codes: codes),
+                                                      position: :surfix)
+                   else
+                     Events::Records::IndexRecord.new(index: create_typing_index)
+                   end
+
+          create_event(record: record)
+        end
+
+        private
+
+        def find_buffer(buffers)
+          buffers.find { |b| b.type == BUFFER_TYPE }
+        end
 
-          create_event(record: index_record)
+        def pressed_codes(records)
+          codes = []
+          records.each do |r|
+            if r.status == 'pressed'
+              codes << r.code
+            else
+              codes.delete_if { |code| code == r.code }
+            end
+          end
+          codes
         end
 
-        # @param records [Array<Events::Records::KeypressRecord>]
+        # @param code [String]
         # @return [Config::Index]
-        def create_index(records:)
-          code = records.map(&:code).join('+')
+        def create_index(codes:)
           Config::Index.new(
             [
               Config::Index::Key.new('keypress', skippable: true),
-              Config::Index::Key.new(code, skippable: true)
+              Config::Index::Key.new(codes.join('+'), skippable: true)
+            ]
+          )
+        end
+
+        # @param status [String]
+        # @return [Config::Index]
+        def create_typing_index
+          Config::Index.new(
+            [
+              Config::Index::Key.new('typing')
             ]
           )
         end

data/lib/fusuma/plugin/events/records/keypress_record.rb

@@ -12,6 +12,7 @@ module Fusuma
           def initialize(status:, code:)
             @status = status
             @code = code
+            super()
           end
         end
       end

data/lib/fusuma/plugin/filters/keypress_filter.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'fusuma/device'
+
 module Fusuma
   module Plugin
     module Filters
@@ -7,10 +9,54 @@ module Fusuma
       class KeypressFilter < Filter
         DEFAULT_SOURCE = 'libinput_command_input'
 
+        def config_param_types
+          {
+            source: String,
+            keep_device_names: [Array, String]
+          }
+        end
+
+        # NOTE: example of line# Select keyboard devices for filtering devices pressed/released
+        # event4   KEYBOARD_KEY      +4.81s      KEY_LEFTSHIFT (42) pressed
+        # event4   KEYBOARD_KEY      +4.90s      KEY_LEFTSHIFT (42) released
+        # event4   KEYBOARD_KEY      +7.39s      KEY_CAPSLOCK (58) pressed
+        # event4   KEYBOARD_KEY      +7.52s      KEY_CAPSLOCK (58) released
+        # event4   KEYBOARD_KEY      +8.98s      KEY_LEFTCTRL (29) pressed
+        # event4   KEYBOARD_KEY      +9.14s      KEY_LEFTCTRL (29) released
+
         # @return [TrueClass] when keeping it
         # @return [FalseClass] when discarding it
         def keep?(record)
-          record.to_s =~ /\sKEYBOARD_KEY\s/
+          keep_devices.any? do |d|
+            record.to_s =~ /#{d.id}\s+KEYBOARD_KEY\s/
+          end
+        end
+
+        private
+
+        # @return [Array<Fusuma::Device>]
+        def keep_devices
+          @keep_devices ||= KeepDevice.new(config_params(:keep_device_names)).select
+        end
+
+        # Devices to detect key presses and releases
+        class KeepDevice
+          def initialize(names)
+            @names = names
+          end
+
+          # @return [Array<Fusuma::Device>]
+          def select
+            if @names
+              Fusuma::Device.all.select do |d|
+                Array(config_params(:keep_device_names)).any? do |name|
+                  d.name =~ name
+                end
+              end
+            else
+              Fusuma::Device.all.select { |d| d.capabilities =~ /keyboard/ }
+            end
+          end
         end
       end
     end

data/lib/fusuma/plugin/keypress/version.rb

@@ -3,7 +3,7 @@
 module Fusuma
   module Plugin
     module Keypress
-      VERSION = '0.4.2'
+      VERSION = '0.5.0'
     end
   end
 end

data/lib/fusuma/plugin/parsers/keypress_parser.rb

@@ -7,18 +7,6 @@ module Fusuma
       class KeypressParser < Parser
         DEFAULT_SOURCE = 'libinput_command_input'
 
-        AVAILABLE_KEYS = %w[
-          CAPSLOCK
-          LEFTALT
-          LEFTCTRL
-          LEFTMETA
-          LEFTSHIFT
-          RIGHTALT
-          RIGHTCTRL
-          RIGHTSHIFT
-          RIGHTMETA
-        ].freeze
-
         # @param record [String]
         # @return [Records::Gesture, nil]
         def parse_record(record)
@@ -39,8 +27,6 @@ module Fusuma
             code = matched[2]   # LEFTSHIFT
             status = matched[3] # pressed
 
-            return unless AVAILABLE_KEYS.include?(code)
-
             Events::Records::KeypressRecord.new(status: status, code: code)
           end
         end

data/spec/fusuma/plugin/filters/keypress_filter_spec.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+require 'fusuma/plugin/filters/filter'
+require 'fusuma/plugin/inputs/input'
+
+require './lib/fusuma/plugin/filters/keypress_filter'
+
+module Fusuma
+  module Plugin
+    module Filters
+      RSpec.describe KeypressFilter do
+        describe '#keep?' do
+          before { @filter = KeypressFilter.new }
+          context 'with keyboard event' do
+            before do
+              keyboard = double(Fusuma::Device, id: 'event4')
+              allow(@filter).to receive(:keep_devices).and_return([keyboard])
+              text = " #{keyboard.id}   KEYBOARD_KEY      +4.81s      KEY_LEFTSHIFT (42) pressed"
+              @event = Events::Event.new(tag: 'libinput_command_input', record: text)
+              # @filter = KeypressFilter.new
+            end
+            it 'should be true' do
+              expect(@filter.keep?(@event.record)).to eq true
+            end
+          end
+          context 'with multiple keyboards' do
+            before do
+              keyboard1 = double(Fusuma::Device, id: 'event1')
+              keyboard2 = double(Fusuma::Device, id: 'event2')
+              allow(@filter).to receive(:keep_devices).and_return([
+                                                                    keyboard1, keyboard2
+                                                                  ])
+              text1 = " #{keyboard1.id}   KEYBOARD_KEY      +4.81s      KEY_LEFTSHIFT (42) pressed"
+              text2 = " #{keyboard2.id}   KEYBOARD_KEY      +4.81s      KEY_LEFTSHIFT (42) pressed"
+              @event1 = Events::Event.new(tag: 'libinput_command_input', record: text1)
+              @event2 = Events::Event.new(tag: 'libinput_command_input', record: text2)
+            end
+            it 'should return multiple keyboards' do
+              expect(@filter.keep?(@event1.record)).to eq true
+              expect(@filter.keep?(@event2.record)).to eq true
+            end
+          end
+          context 'when touchpad events' do
+            before do
+              touchpad = double(Fusuma::Device, id: 'event18')
+              allow(@filter).to receive(:keep_devices).and_return([touchpad])
+              text = " #{touchpad.id}  GESTURE_SWIPE_UPDATE  +1.44s  4 11.23/ 1.00 (36.91/ 3.28 unaccelerated) "
+              #                        ^^^^^^^^^^^^^^^^^^^^  Shoud be KEYBOARD_KEY
+              @event = Events::Event.new(tag: 'libinput_command_input', record: text)
+            end
+            it 'should be false' do
+              expect(@filter.keep?(@event.record)).to eq false
+            end
+          end
+
+          context 'with plugins.filters.keypress_filter.source=CUSTOM_INPUT' do
+            it { expect(@filter.source).to eq 'libinput_command_input' }
+
+            context 'with config' do
+              around do |example|
+                @custom_source = 'CUSTOM_INPUT'
+
+                ConfigHelper.load_config_yml = <<~CONFIG
+                  plugin:
+                   filters:
+                     keypress_filter:
+                       source: #{@custom_source}
+                CONFIG
+
+                example.run
+
+                Config.custom_path = nil
+              end
+
+              it { expect(@filter.source).to eq @custom_source }
+            end
+          end
+          context "with config file having plugins.filters.keypress.keep_device_names='CUSTOM_KEYBOARD'" do
+            it { expect(@filter.source).to eq 'libinput_command_input' }
+
+            context 'with config' do
+              around do |example|
+                @name = 'CUSTOM_KEYBOARD'
+
+                ConfigHelper.load_config_yml = <<~CONFIG
+                  plugin:
+                   filters:
+                     keypress_filter:
+                       keep_device_names: #{@name}
+                CONFIG
+
+                example.run
+
+                Config.custom_path = nil
+              end
+
+              it { expect(@filter.config_params[:keep_device_names]).to eq @name }
+            end
+          end
+          context "with config file having plugins.filters.keypress.keep_device_names=['INTERNAL_KEYBOARD','EXTERNAL_KEYBOARD']" do
+            it { expect(@filter.source).to eq 'libinput_command_input' }
+
+            context 'with config' do
+              around do |example|
+                @name1 = 'INTERNAL_KEYBOARD'
+                @name2 = 'EXTERNAL_KEYBOARD'
+
+                ConfigHelper.load_config_yml = <<~CONFIG
+                  plugin:
+                   filters:
+                     keypress_filter:
+                       keep_device_names:
+                        - #{@name1}
+                        - #{@name2}
+                CONFIG
+
+                example.run
+
+                Config.custom_path = nil
+              end
+
+              it { expect(@filter.config_params(:keep_device_names)).to eq [@name1, @name2] }
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma-plugin-keypress
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - iberianpig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-03 00:00:00.000000000 Z
+date: 2021-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fusuma
@@ -44,13 +44,15 @@ files:
 - lib/fusuma/plugin/keypress/version.rb
 - lib/fusuma/plugin/parsers/keypress_parser.rb
 - spec/fusuma/plugin/detectors/keypress_detector_spec.rb
+- spec/fusuma/plugin/filters/keypress_filter_spec.rb
 - spec/fusuma/plugin/keypress_spec.rb
 - spec/helpers/config_helper.rb
 - spec/spec_helper.rb
 homepage: https://github.com/iberianpig/fusuma-plugin-keypress
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -66,12 +68,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Keypress plugin for Fusuma
 test_files:
-- spec/fusuma/plugin/detectors/keypress_detector_spec.rb
-- spec/fusuma/plugin/keypress_spec.rb
-- spec/helpers/config_helper.rb
 - spec/spec_helper.rb
+- spec/helpers/config_helper.rb
+- spec/fusuma/plugin/filters/keypress_filter_spec.rb
+- spec/fusuma/plugin/keypress_spec.rb
+- spec/fusuma/plugin/detectors/keypress_detector_spec.rb