fusuma-plugin-tap 0.1.3 → 0.4.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e02d886ca531aba36e5b71ed134b76062a72430a17a21f7a0a5a5941652c657f
-  data.tar.gz: 8107fa9c300cd78028589198fe64ee4897bf5abbf3dc1621779102d0a3d66c58
+  metadata.gz: 17a8597b18f259832d7d6d0dce336d6d9435d000a1adc6656a1dc67b53d3037e
+  data.tar.gz: 5f909eb2fe3be8766cef41235c80710880a51ebde67c0e91e76affe12b000722
 SHA512:
-  metadata.gz: 45f9c11102b3b6e530c647c9b8c7c9f10e5ea9820f5742cb858ea2dd2a014e5fbcb0b0ba37821d6c88268111c548a0276b0319a004ccd8ffeb64ca4e9eb31b3e
-  data.tar.gz: 904e5c91e57005cf20000986621979b2da18abf171161b6b831a7ffb8432d4bed6e408352655107c9c8667ddc7aea9c5d545e48a147b900775325d3a3be361df
+  metadata.gz: fe0c32c71db497489620a5ceefbb4ac172c8d7003fe957432f3a779e27ed7ecbe5f4c96c3f23a38f67bc557421d250e0582a729eef31cb00f2b248606826d4f5
+  data.tar.gz: 5f8b2730af48d13f85f4bdf42073669f7d8aea9eb0d2a70f4c521327b2aa1506714c50d80c21fbd3e516ced76cf72015976593a6859b602c71ed38b6df6c534a

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,19 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-04-20 01:40:44 +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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: TreatCommentsAsGroupSeparators, Include.
-# Include: **/*.gemspec
-Gemspec/OrderedDependencies:
-  Exclude:
-    - 'fusuma-plugin-tap.gemspec'
-
 # Offense count: 1
 # Configuration parameters: Include.
 # Include: **/*.gemspec
@@ -24,7 +16,7 @@ Gemspec/RequiredRubyVersion:
 # Offense count: 5
 # Configuration parameters: IgnoredMethods.
 Metrics/AbcSize:
-  Max: 38
+  Max: 42
 
 # Offense count: 1
 # Configuration parameters: CountComments, ExcludedMethods.
@@ -32,20 +24,20 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   Max: 33
 
-# Offense count: 1
+# Offense count: 3
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 22
+  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: 10
+  Max: 13
 
 # Offense count: 1
 Style/Documentation:
@@ -53,3 +45,12 @@ Style/Documentation:
     - 'spec/**/*'
     - 'test/**/*'
     - 'bin/evemu_recorder.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, EnforcedStyle, IgnoredMethods.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/fusuma/plugin/detectors/tap_detector.rb'

data/.travis.yml

@@ -5,8 +5,9 @@ cache: bundler
 
 env:
   matrix:
-    - SPEC_LIBINPUT_VERSION=1.10.4
-    - SPEC_LIBINPUT_VERSION=1.14.1
+    - LIBINPUT_VERSION=1.10.4
+    - LIBINPUT_VERSION=1.14.1
+    - LIBINPUT_VERSION=1.15.5
 
 cache:
   directories:
@@ -17,5 +18,6 @@ rvm:
   - 2.4
   - 2.5
   - 2.6
+  - 2.7
 
 before_install: gem install bundler --no-document -v 2.0.1

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

@@ -0,0 +1,14 @@
+.PHONY: all test clean
+
+all: help
+
+build: ## build libinput with LIBINPUT_VERSION
+	cd $(LIBINPUT_SOURCE_DIR) && \
+		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
+
+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

@@ -12,6 +12,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
@@ -89,7 +90,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.5'
+  spec.add_dependency 'fusuma', '~> 2.0.0.pre'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'github_changelog_generator', '~> 1.14'

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

@@ -14,10 +14,15 @@ module Fusuma
           }
         end
 
+        # clear old events
+        def clear_expired(*)
+          clear if @events.any? { |e| ended?(e) }
+        end
+
         # @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)
@@ -38,19 +43,21 @@ module Fusuma
         def bufferable?(event)
           case event.record.status
           when 'end'
-            false
+            true
           when 'begin'
             if empty?
               true
             else
               false
             end
-          else
+          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

@@ -12,29 +12,33 @@ module Fusuma
 
         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,23 +57,33 @@ 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' }
+          release_num = buffer.events.count { |e| e.record.status =~ /release|end/ }
           MultiLogger.debug(touch_num: touch_num, release_num: release_num)
 
           case buffer.finger
@@ -80,12 +94,22 @@ module Fusuma
           when 3
             touch_num == release_num + 1
           when 4
-            touch_num == release_num + 1
+            touch_num > 0 && release_num > 0
           else
             false
           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:)

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

@@ -54,19 +54,24 @@ module Fusuma
           gesture = 'tap'
 
           case record.to_s
-            # BEGIN
+
+          # BEGIN
           when /\stap(?:| state):\s.*TAP_STATE_IDLE → TAP_EVENT_TOUCH → TAP_STATE_TOUCH/
             status = 'begin'
             finger = 1
 
-            # TOUCH
-          when /\stap(?:| state):\s.*(#{STATE[:touches].join('|')}) → TAP_EVENT_TOUCH → (#{STATE[:touches].join('|')})/
+          # TOUCH
+          when /\stap(?:| state):\s.*(#{STATE[:touches].join('|')}) → TAP_EVENT_(?:TOUCH|MOTION) → (#{STATE[:touches].join('|')})/
 
             status = 'touch'
 
             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'
@@ -93,11 +98,16 @@ module Fusuma
                        1
                      end
           # KEEP
-          when /\sgesture(| state):\s/
+          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('|')})/
 
@@ -121,6 +131,8 @@ module Fusuma
 
             matched = Regexp.last_match
             finger = case matched[1]
+                     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'

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma-plugin-tap
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.4.0.pre
 platform: ruby
 authors:
 - iberianpig
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2020-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fusuma
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 2.0.0.pre
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 2.0.0.pre
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -152,6 +152,7 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
 - bin/console
@@ -168,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
@@ -179,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: []