fusuma-plugin-tap 0.2.0 → 0.4.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8d626266cb1c6e86fce7c6e8f70d864dd705750299e0dce5e9c7ea30ddc27d2
-  data.tar.gz: f230dbefeaf8e249b7d05e880f55164841335580ae521f08e482cf0e91d64990
+  metadata.gz: c46c3f606aa83757b439afac123cd8efd4a87b3205ccb0364ca565998ee4e6e2
+  data.tar.gz: cd0db523002ead56784c44df3b8443d635cb5c8dc4c8aa0a1616994eabf1c44e
 SHA512:
-  metadata.gz: cd656a66fcd871a8fcee663df9b37595f5c0f5beae784104e4fc3a3bf75e7d9192bafdda5c6229e94873a8efbec61fde6527426d20b0f93ac4e4691396eb8c9e
-  data.tar.gz: b29ba3b5929c037731d8f759e007436fa8db1f2b83b30e455a0ef8daa7658a8f8b367ac83513b6e20cd647def3257c0ea486e7c4768b11d2ee1f1cc21a80d075
+  metadata.gz: 920c2f083dde9a3c67edb42de1295941812e992e0753b05da482169aba8f2596c1a18802c6d67218bb8b5f07c44862a067e9a02945041b6c0c6ee7eaeeae8e80
+  data.tar.gz: fb8b27a7ed3853428ecc810c3ffdaf941676a2575eced35d4d264f6191df782cb0f1e7bf770f21d01caaeb92611821e1c825b99dcc96a242866c02ab83fd74ac

data/.rubocop.yml

@@ -18,6 +18,11 @@ Metrics/MethodLength:
     - 'lib/fusuma/plugin/parsers/tap_parser.rb'
     - 'lib/fusuma/plugin/parsers/tap_detector.rb'
 
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/fusuma/plugin/parsers/tap_parser.rb'
+    - 'lib/fusuma/plugin/parsers/tap_detector.rb'
+
 Layout/LineLength:
   Max: 100
   Exclude:

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-05-04 22:12:29 +0900 using RuboCop version 0.82.0.
+# on 2020-07-05 15:49:25 UTC using RuboCop version 0.86.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -16,7 +16,7 @@ Gemspec/RequiredRubyVersion:
 # Offense count: 5
 # Configuration parameters: IgnoredMethods.
 Metrics/AbcSize:
-  Max: 38
+  Max: 42
 
 # Offense count: 1
 # Configuration parameters: CountComments, ExcludedMethods.
@@ -24,20 +24,20 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   Max: 33
 
-# Offense count: 1
+# Offense count: 3
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 23
+  Max: 25
 
 # Offense count: 5
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
   Max: 45
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 11
+  Max: 13
 
 # Offense count: 1
 Style/Documentation:

data/CHANGELOG.md

@@ -1,5 +1,53 @@
 # Changelog
 
+## [v0.4.0.pre](https://github.com/iberianpig/fusuma-plugin-tap/tree/v0.4.0.pre) (2020-11-09)
+
+[Full Changelog](https://github.com/iberianpig/fusuma-plugin-tap/compare/v0.3.2...v0.4.0.pre)
+
+## [v0.3.2](https://github.com/iberianpig/fusuma-plugin-tap/tree/v0.3.2) (2020-08-13)
+
+[Full Changelog](https://github.com/iberianpig/fusuma-plugin-tap/compare/v0.3.1...v0.3.2)
+
+**Fixed bugs:**
+
+- Fix Parser when detecting a false 4 finger tap after a pinch gesture [\#5](https://github.com/iberianpig/fusuma-plugin-tap/pull/5) ([iberianpig](https://github.com/iberianpig))
+
+**Closed issues:**
+
+- tap 4 not registered [\#4](https://github.com/iberianpig/fusuma-plugin-tap/issues/4)
+
+**Merged pull requests:**
+
+- test\(tap\_parser\): reproduce the bug that 4 finger tap after detecting palm [\#8](https://github.com/iberianpig/fusuma-plugin-tap/pull/8) ([iberianpig](https://github.com/iberianpig))
+
+## [v0.3.1](https://github.com/iberianpig/fusuma-plugin-tap/tree/v0.3.1) (2020-05-15)
+
+[Full Changelog](https://github.com/iberianpig/fusuma-plugin-tap/compare/v0.3.0...v0.3.1)
+
+**Closed issues:**
+
+- Reduce false positives with Hold gesture [\#2](https://github.com/iberianpig/fusuma-plugin-tap/issues/2)
+
+## [v0.3.0](https://github.com/iberianpig/fusuma-plugin-tap/tree/v0.3.0) (2020-05-10)
+
+[Full Changelog](https://github.com/iberianpig/fusuma-plugin-tap/compare/v0.2.0...v0.3.0)
+
+**Closed issues:**
+
+- 4 finger tap / hold is not being registered [\#1](https://github.com/iberianpig/fusuma-plugin-tap/issues/1)
+
+## [v0.2.0](https://github.com/iberianpig/fusuma-plugin-tap/tree/v0.2.0) (2020-05-05)
+
+[Full Changelog](https://github.com/iberianpig/fusuma-plugin-tap/compare/v0.1.3...v0.2.0)
+
+**Merged pull requests:**
+
+- Support libinput v1.15.5 [\#3](https://github.com/iberianpig/fusuma-plugin-tap/pull/3) ([iberianpig](https://github.com/iberianpig))
+
+## [v0.1.3](https://github.com/iberianpig/fusuma-plugin-tap/tree/v0.1.3) (2020-04-20)
+
+[Full Changelog](https://github.com/iberianpig/fusuma-plugin-tap/compare/v0.1.1...v0.1.3)
+
 ## [v0.1.1](https://github.com/iberianpig/fusuma-plugin-tap/tree/v0.1.1) (2020-04-19)
 
 [Full Changelog](https://github.com/iberianpig/fusuma-plugin-tap/compare/v0.1.0...v0.1.1)

data/Makefile

@@ -3,11 +3,22 @@
 all: help
 
 build: ## build libinput with LIBINPUT_VERSION
-	cd $(LIBINPUT_SOURCE_DIR) && \
+	cd $(LIBINPUT_REPO) && \
+		git fetch && \
 		git checkout $(LIBINPUT_VERSION) && \
-		meson --prefix=/usr builddir/ -Dlibwacom=false -Ddebug-gui=false -Dtests=false -Ddocumentation=false --reconfigure && \
-		ninja -C builddir/
-	$(LIBINPUT_LIST_DEVICES) --version
+		mkdir -p builddir/$(LIBINPUT_VERSION)/ && \
+		meson --prefix=/usr builddir/$(LIBINPUT_VERSION)/ -Dlibwacom=false -Ddebug-gui=false -Dtests=false -Ddocumentation=false && \
+		ninja -C builddir/$(LIBINPUT_VERSION)/
+	$(LIBINPUT_REPO)/builddir/$(LIBINPUT_VERSION)/libinput-list-devices --version
+
+version: ## libinput list-devces --version
+	$(LIBINPUT_REPO)/builddir/$(LIBINPUT_VERSION)/libinput-list-devices --version
+
+list-devices: ## libinput list-devices
+	$(LIBINPUT_REPO)/builddir/$(LIBINPUT_VERSION)/libinput-list-devices
+
+debug-events: ## libinput debug-events
+	$(LIBINPUT_REPO)/builddir/$(LIBINPUT_VERSION)/libinput-debug-events --enable-tap --verbose
 
 help: ## show help
 	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | uniq | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

data/README.md

@@ -62,6 +62,11 @@ plugin:
       verbose: true
 ```
 
+## Known issues
+* `libinput debug-events --verbose` outputs is unstable, so it may not work properly with some versions of libinput.
+* **libinput 1.10.4 contains a bug that suddenly stopped detecting taps.**
+  * ref: https://github.com/iberianpig/fusuma-plugin-tap/pull/8
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/libinput_debug_events_generator.rb

@@ -4,6 +4,7 @@
 require 'fileutils'
 require 'pathname'
 require 'fusuma/device'
+require 'fusuma/plugin/inputs/libinput_command_input'
 
 # Generate libinput generator
 class LibinputDebugEventsGenerator
@@ -12,6 +13,7 @@ class LibinputDebugEventsGenerator
     @gesture_name = Pathname.new(evemu_record).basename
     @list_devices = ENV.fetch('LIBINPUT_LIST_DEVICES', 'libinput list-devices')
     @debug_events = ENV.fetch('LIBINPUT_DEBUG_EVENTS', 'libinput debug-events')
+    @libinput_version = ENV.fetch('LIBINPUT_VERSION', 'libinput list-devices')
   end
 
   def generate_debug_events
@@ -40,6 +42,10 @@ class LibinputDebugEventsGenerator
       rescue Timeout::Error
         puts 'cut out device infos'
       end
+      if `which evemu-play` == ''
+        warn 'evemu-play is not found'
+        exit 1
+      end
 
       command = "evemu-play /dev/input/#{device_id} < #{@evemu_record}"
 
@@ -89,7 +95,9 @@ class LibinputDebugEventsGenerator
   end
 
   def version
-    @version ||= `#{@list_devices} --version`.chomp
+    raise 'Make rebuild libinput' unless @libinput_version == `#{@list_devices} --version`.chomp
+
+    @libinput_version
   end
 end
 

data/fusuma-plugin-tap.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.3' # https://packages.ubuntu.com/search?keywords=ruby&searchon=names&exact=1&suite=all&section=main
 
-  spec.add_dependency 'fusuma', '~> 1.10'
+  spec.add_dependency 'fusuma', '~> 2.0.0.pre2'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'github_changelog_generator', '~> 1.14'

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

@@ -22,7 +22,7 @@ module Fusuma
         # @param event [Event]
         # @return [NilClass, TapBuffer]
         def buffer(event)
-          return if event&.tag != source
+          return unless event&.tag == source
 
           # NOTE: need to set `begin` event at first of buffer
           clear && return unless bufferable?(event)
@@ -50,12 +50,14 @@ module Fusuma
             else
               false
             end
-          else # 'keep', 'touch', 'hold', 'release'
+          when 'keep', 'touch', 'hold', 'release', 'move'
             if empty?
               false
             else
               true
             end
+          else
+            raise "Unexpected status: #{event.record.status}"
           end
         end
 

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

@@ -7,34 +7,39 @@ module Fusuma
     module Detectors
       # Detect tap event
       class TapDetector < Detector
+        SOURCES = ['tap', 'gesture', 'timer']
         BUFFER_TYPE = 'tap'
         GESTURE_RECORD_TYPE = 'tap'
 
         BASE_INTERVAL = 0.5
         BASE_HOLDING_TIME = 0.1
-        BASE_TAP_TIME = 1
+        BASE_TAP_TIME = 0.4
 
         # @param buffers [Array<Buffer>]
         # @return [Event] if event is detected
         # @return [NilClass] if event is NOT detected
         def detect(buffers)
-          buffer = buffers.find { |b| b.type == BUFFER_TYPE }
+          tap_buffer = buffers.find { |b| b.type == BUFFER_TYPE }
+          gesture_buffer = buffers.find { |b| b.type == 'gesture' }
+          timer_buffer = buffers.find { |b| b.type == 'timer' }
 
-          return if buffer.empty?
-
-          finger = buffer.finger
+          if tap_buffer.empty? || moved?(tap_buffer: tap_buffer, gesture_buffer: gesture_buffer)
+            return
+          end
 
-          holding_time = buffer.events.last.time - buffer.events.first.time
+          holding_time = calc_holding_time(tap_buffer: tap_buffer, timer_buffer: timer_buffer)
 
-          direction = if hold?(buffer, holding_time)
+          direction = if hold?(tap_buffer, holding_time)
                         'hold'
-                      elsif tap?(buffer, holding_time)
+                      elsif tap?(tap_buffer, holding_time)
                         'tap'
                       end
 
           return if direction.nil?
 
-          buffer.clear
+          finger = tap_buffer.finger
+
+          tap_buffer.clear # NOTE: Clear after detecting hold
 
           index = create_index(finger: finger, direction: direction)
 
@@ -53,21 +58,31 @@ module Fusuma
           )
         end
 
+        # @return [TrueClass, FalseClass]
         def hold?(buffer, holding_time)
-          return false if holding_time < 1
+          return false if holding_time < 0.7
 
           return true if buffer.finger == 4
 
           true if buffer.events.any? { |e| e.record.status == 'hold' }
         end
 
+        # @return [TrueClass, FalseClass]
         def tap?(buffer, holding_time)
           return false if holding_time > 0.15
 
-          tap_released?(buffer)
+          released_all?(buffer)
+        end
+
+        # @return [TrueClass, FalseClass]
+        def moved?(tap_buffer:, gesture_buffer:)
+          tap_buffer.events.any? { |e| e.record.status == 'move' } ||
+            # FIXME: Find good parameter for ignoring
+            gesture_buffer.events.count { |e| tap_buffer.events.first.time < e.time } > 5
         end
 
-        def tap_released?(buffer)
+        # @return [TrueClass, FalseClass]
+        def released_all?(buffer)
           touch_num = buffer.events.count { |e| (e.record.status =~ /begin|touch/) }
           release_num = buffer.events.count { |e| e.record.status =~ /release|end/ }
           MultiLogger.debug(touch_num: touch_num, release_num: release_num)
@@ -86,6 +101,16 @@ module Fusuma
           end
         end
 
+        def calc_holding_time(tap_buffer:, timer_buffer:)
+          last_time = if timer_buffer && !timer_buffer.empty? &&
+                         (tap_buffer.events.last.time < timer_buffer.events.last.time)
+                        timer_buffer.events.last.time
+                      else
+                        tap_buffer.events.last.time
+                      end
+          last_time - tap_buffer.events.first.time
+        end
+
         private
 
         def enough?(index:, direction:)
@@ -102,12 +127,12 @@ module Fusuma
         def interval_time(index:, direction:)
           @interval_time ||= {}
           @interval_time[index.cache_key] ||= begin
-                               keys_specific = Config::Index.new [*index.keys, 'interval']
-                               keys_global = Config::Index.new ['interval', direction]
-                               config_value = Config.search(keys_specific) ||
-                                              Config.search(keys_global) || 1
-                               BASE_INTERVAL * config_value
-                             end
+            keys_specific = Config::Index.new [*index.keys, 'interval']
+            keys_global = Config::Index.new ['interval', direction]
+            config_value = Config.search(keys_specific) ||
+                           Config.search(keys_global) || 1
+            BASE_INTERVAL * config_value
+          end
         end
       end
     end

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

@@ -67,7 +67,11 @@ module Fusuma
 
             finger = case Regexp.last_match(2)
                      when 'TAP_STATE_DEAD'
-                       4
+                       if Regexp.last_match(1) == 'TAP_STATE_TOUCH_3'
+                         4
+                       else
+                         0
+                       end
                      when 'TAP_STATE_TOUCH_3'
                        3
                      when 'TAP_STATE_TOUCH_2'
@@ -94,11 +98,16 @@ module Fusuma
                        1
                      end
           # KEEP
-          when /\sgesture(| state):\s/, 'LIBINPUT TIMEOUT'
+          when /\sgesture(| state):\s/ # 1.10.4 prints "gesture state: GESTURE_STATE_.*"
             # NOTE: treat the "gesture(| state):" as KEEP
             status = 'keep'
             finger = 0
 
+          # MOVE
+          when /\sPOINTER_AXIS\s/, /\sPOINTER_MOTION\s/, /\sTAP_EVENT_PALM\s/
+            status = 'move'
+            finger = 0
+
           # RELEASE
           when /\stap(?:| state):\s.*(#{(STATE[:touches] | STATE[:holds]).join('|')}) → TAP_EVENT_RELEASE → (#{STATE[:releases].join('|')})/
 
@@ -122,8 +131,8 @@ module Fusuma
 
             matched = Regexp.last_match
             finger = case matched[1]
-                     when 'TAP_STATE_DEAD'
-                       4
+                     when 'TAP_STATE_DEAD' # NOTE: 2 finger hold -> scroll become  TAP_STATE_DEAD
+                       0
                      when 'TAP_STATE_TOUCH_3', 'TAP_STATE_TOUCH_3_HOLD'
                        3
                      when 'TAP_STATE_TOUCH_2', 'TAP_STATE_TOUCH_2_HOLD', 'TAP_STATE_TOUCH_2_RELEASE'
@@ -138,7 +147,7 @@ module Fusuma
           Events::Records::GestureRecord.new(status: status,
                                              gesture: gesture,
                                              finger: finger,
-                                             direction: nil)
+                                             delta: nil)
         end
 
         def tag

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

@@ -3,7 +3,7 @@
 module Fusuma
   module Plugin
     module Tap
-      VERSION = '0.2.0'
+      VERSION = '0.4.0.pre2'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma-plugin-tap
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0.pre2
 platform: ruby
 authors:
 - iberianpig
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-05 00:00:00.000000000 Z
+date: 2021-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fusuma
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 2.0.0.pre2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 2.0.0.pre2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -169,7 +169,7 @@ homepage: https://github.com/iberianpig/fusuma-plugin-tap
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -180,12 +180,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Tap gesture plugin for Fusuma
 test_files: []