fusuma-plugin-keypress 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4dee24a10fad696ea3f6fd58e02e1c2358f522455bc9ec4aef6bc53b2004d2c
-  data.tar.gz: 3e0016a1d55bc7cb4096c9a77916fa1910e8a81561992255c97b17a8a67d6ddf
+  metadata.gz: d551f984dfdbac5d6095387156cf211450a23e45701737713cc5c5be261081d2
+  data.tar.gz: e3446a313462ad562e0dd4eabb112c1e3d39735523315c0e34f90c51b12ad655
 SHA512:
-  metadata.gz: 22187a3a208c1d0989eac56c565cf00124920bb141d38f3549743c473c0b42708256c73d6c7603c6776f245a46c3ae6df8f791ba4e51f9c09de47f529b8b008b
-  data.tar.gz: e7f937130567f31bb3b226b3cb502f98fff973aceb21a68813170fa77d0ea80e1e531c5fabf1e0c57e56c463072ed14a1f3e9f28fc5201eca69610cdfea56f5b
+  metadata.gz: 69a1272b0938d590b72d8b94fcab0d37fdb6af71111e936e1e817a8acffca0c05a9907795027e796d081731a605b719e8999125d0124cb657996d95379340dd8
+  data.tar.gz: 7e26101b157dd1fcef0d061c3666a9c23402434667054a98e829f9969f8f1391e3c8c108d49220a7e8b9433b831b6507a4b543cbdb5a5c4b1334b456621292ea

data/README.md

@@ -81,29 +81,6 @@ 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

@@ -1,31 +1,30 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'fusuma/plugin/keypress/version'
+require "fusuma/plugin/keypress/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'fusuma-plugin-keypress'
-  spec.version       = Fusuma::Plugin::Keypress::VERSION
-  spec.authors       = ['iberianpig']
-  spec.email         = ['yhkyky@gmail.com']
+  spec.name = "fusuma-plugin-keypress"
+  spec.version = Fusuma::Plugin::Keypress::VERSION
+  spec.authors = ["iberianpig"]
+  spec.email = ["yhkyky@gmail.com"]
 
-  spec.summary       = 'Keypress plugin for Fusuma '
-  spec.description   = 'fusuma-plugin-keypress is Fusuma plugin for keypress combination.'
-  spec.homepage      = 'https://github.com/iberianpig/fusuma-plugin-keypress'
-  spec.license       = 'MIT'
+  spec.summary = "Keypress plugin for Fusuma "
+  spec.description = "fusuma-plugin-keypress is Fusuma plugin for keypress combination."
+  spec.homepage = "https://github.com/iberianpig/fusuma-plugin-keypress"
+  spec.license = "MIT"
 
   # Specify which files should be added to the gem when it is released.
-  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']
+  spec.files = Dir["{bin,lib,exe}/**/*", "LICENSE*", "README*", "*.gemspec"]
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.5.1' # https://packages.ubuntu.com/search?keywords=ruby&searchon=names&exact=1&suite=all&section=main
+  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.add_dependency "fusuma", "~> 2.0"
   spec.metadata = {
-    'rubygems_mfa_required' => 'true'
+    "rubygems_mfa_required" => "true"
   }
 end

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

@@ -5,7 +5,7 @@ module Fusuma
     module Buffers
       # Buffer events having KeypressRecord
       class KeypressBuffer < Buffer
-        DEFAULT_SOURCE = 'keypress_parser'
+        DEFAULT_SOURCE = "keypress_parser"
 
         # @param event [Event]
         def buffer(event)
@@ -30,7 +30,7 @@ module Fusuma
         private
 
         def released?
-          true if @events.last.record.status =~ /released/
+          true if /released/.match?(@events.last.record.status)
         end
       end
     end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'set'
+require "set"
 
 module Fusuma
   module Plugin
@@ -8,19 +8,19 @@ module Fusuma
       # Detect KeypressEvent from KeypressBuffer
       class KeypressDetector < Detector
         SOURCES = %w[keypress].freeze
-        BUFFER_TYPE = 'keypress'
+        BUFFER_TYPE = "keypress"
 
         MODIFIER_KEYS = Set.new(%w[
-                                  CAPSLOCK
-                                  LEFTALT
-                                  LEFTCTRL
-                                  LEFTMETA
-                                  LEFTSHIFT
-                                  RIGHTALT
-                                  RIGHTCTRL
-                                  RIGHTSHIFT
-                                  RIGHTMETA
-                                ])
+          CAPSLOCK
+          LEFTALT
+          LEFTCTRL
+          LEFTMETA
+          LEFTSHIFT
+          RIGHTALT
+          RIGHTCTRL
+          RIGHTSHIFT
+          RIGHTMETA
+        ])
 
         # Always watch buffers and detect them.
         def watch?
@@ -37,14 +37,12 @@ module Fusuma
 
           codes = pressed_codes(keypress_buffer.events.map(&:record))
 
-          return if codes.empty?
+          return unless codes.any? { |code| MODIFIER_KEYS.include?(code) }
 
-          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
+          record = Events::Records::IndexRecord.new(
+            index: create_index(codes: codes),
+            position: :surfix
+          )
 
           create_event(record: record)
         end
@@ -58,7 +56,7 @@ module Fusuma
         def pressed_codes(records)
           codes = []
           records.each do |r|
-            if r.status == 'pressed'
+            if r.status == "pressed"
               codes << r.code
             else
               codes.delete_if { |code| code == r.code }
@@ -72,18 +70,8 @@ module Fusuma
         def create_index(codes:)
           Config::Index.new(
             [
-              Config::Index::Key.new('keypress', 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')
+              Config::Index::Key.new("keypress", skippable: true),
+              Config::Index::Key.new(codes.join("+"), skippable: true)
             ]
           )
         end

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

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'fusuma/device'
+require "fusuma/device"
 
 module Fusuma
   module Plugin
     module Filters
       # Filter keyboard events from libinput_command_input
       class KeypressFilter < Filter
-        DEFAULT_SOURCE = 'libinput_command_input'
+        DEFAULT_SOURCE = "libinput_command_input"
 
         def config_param_types
           {

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

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

data/lib/fusuma/plugin/keypress.rb

@@ -2,9 +2,9 @@
 
 # fusuma will `require fusuma-plugin-xxxx/plugin/xxxx.rb`
 
-require_relative './keypress/version'
-require_relative './events/records/keypress_record'
-require_relative './filters/keypress_filter'
-require_relative './parsers/keypress_parser'
-require_relative './buffers/keypress_buffer'
-require_relative './detectors/keypress_detector'
+require_relative "./keypress/version"
+require_relative "./events/records/keypress_record"
+require_relative "./filters/keypress_filter"
+require_relative "./parsers/keypress_parser"
+require_relative "./buffers/keypress_buffer"
+require_relative "./detectors/keypress_detector"

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

@@ -5,7 +5,7 @@ module Fusuma
     module Parsers
       # Generate KeypressRecord from libinput_command_input
       class KeypressParser < Parser
-        DEFAULT_SOURCE = 'libinput_command_input'
+        DEFAULT_SOURCE = "libinput_command_input"
 
         # @param record [String]
         # @return [Records::Gesture, nil]
@@ -24,7 +24,7 @@ module Fusuma
           when /KEYBOARD_KEY.+(\d+\.\d+)s.*KEY_([A-Z]+).*(pressed|released)/
             matched = Regexp.last_match
             # time = matched[1]   # 4.81
-            code = matched[2]   # LEFTSHIFT
+            code = matched[2] # LEFTSHIFT
             status = matched[3] # pressed
 
             Events::Records::KeypressRecord.new(status: status, code: code)
@@ -32,7 +32,7 @@ module Fusuma
         end
 
         def tag
-          'keypress_parser'
+          "keypress_parser"
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma-plugin-keypress
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - iberianpig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-24 00:00:00.000000000 Z
+date: 2022-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fusuma
@@ -43,11 +43,6 @@ files:
 - lib/fusuma/plugin/keypress.rb
 - 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
@@ -68,13 +63,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Keypress plugin for Fusuma
-test_files:
-- 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
+test_files: []

data/spec/fusuma/plugin/detectors/keypress_detector_spec.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-require 'fusuma/plugin/detectors/detector'
-require 'fusuma/plugin/buffers/buffer'
-
-require './lib/fusuma/plugin/buffers/keypress_buffer'
-require './lib/fusuma/plugin/detectors/keypress_detector'
-
-module Fusuma
-  module Plugin
-    module Detectors
-      RSpec.describe KeypressDetector do
-        before do
-          @detector = KeypressDetector.new
-          @buffer = Buffers::KeypressBuffer.new
-        end
-
-        describe '#detector' do
-          context 'with no keypress event in buffer' do
-            before do
-              @buffer.clear
-            end
-
-            it { expect(@detector.detect([@buffer])).to eq nil }
-          end
-        end
-
-        context 'with keypress events in buffer' do
-          before do
-            record = Events::Records::KeypressRecord.new(status: 'pressed', code: 'LEFTSHIFT')
-            event = Events::Event.new(tag: 'keypress_parser', record: record)
-
-            @buffer.buffer(event)
-          end
-          it { expect(@detector.detect([@buffer])).to be_a Events::Event }
-          it { expect(@detector.detect([@buffer]).record).to be_a Events::Records::IndexRecord }
-          it { expect(@detector.detect([@buffer]).record.index).to be_a Config::Index }
-
-          it 'should detect LEFTSHIFT' do
-            expect(@detector.detect([@buffer]).record.index.keys.map(&:symbol))
-              .to eq(%i[keypress LEFTSHIFT])
-          end
-        end
-
-        context 'with two different keypress events in buffer' do
-          before do
-            record1 = Events::Records::KeypressRecord.new(status: 'pressed', code: 'LEFTSHIFT')
-            record2 = Events::Records::KeypressRecord.new(status: 'pressed', code: 'LEFTCTRL')
-            event1 = Events::Event.new(tag: 'keypress_parser', record: record1)
-            event2 = Events::Event.new(tag: 'keypress_parser', record: record2)
-
-            @buffer.buffer(event1)
-            @buffer.buffer(event2)
-          end
-
-          it 'should detect LEFTSHIFT+LEFTCTRL' do
-            expect(@detector.detect([@buffer]).record.index.keys.map(&:symbol))
-              .to eq(%i[keypress LEFTSHIFT+LEFTCTRL])
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,131 +0,0 @@
-# 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

data/spec/fusuma/plugin/keypress_spec.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-RSpec.describe Fusuma::Plugin::Keypress do
-  it 'has a version number' do
-    expect(Fusuma::Plugin::Keypress::VERSION).not_to be nil
-  end
-end

data/spec/helpers/config_helper.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'tempfile'
-require '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
-  end
-end

data/spec/spec_helper.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'helpers/config_helper'
-
-RSpec.configure do |config|
-  # Enable flags like --only-failures and --next-failure
-  config.example_status_persistence_file_path = '.rspec_status'
-
-  # Disable RSpec exposing methods globally on `Module` and `main`
-  config.disable_monkey_patching!
-
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
-
-  config.include(Fusuma::ConfigHelper)
-end