fusuma-plugin-keypress 0.4.2 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 958f90d65b6a5bfe120a5462bbfc1d21e01dbdf95d97f279e824a6ad6aafa5a3
-  data.tar.gz: 6d8c96cb5be6b003f00c0d20bc6bf68af693857e82d9ceb87837a1b752678e0f
+  metadata.gz: d551f984dfdbac5d6095387156cf211450a23e45701737713cc5c5be261081d2
+  data.tar.gz: e3446a313462ad562e0dd4eabb112c1e3d39735523315c0e34f90c51b12ad655
 SHA512:
-  metadata.gz: 7be790c59d66696f078c89121f32f9dd61630a0debfe3584899cac8b0ed73d335b2858aca88e7d84b511dcb1cbaf9a0e36ac487300c519f2c5480ac7f16a4040
-  data.tar.gz: 858e05f1aca03e80be587ed315e79717a5c6815336c5b1ef8e1c112603df698be6d3b720853c18f2b200137b8c9eb866907e325032c8727ee6d1ffba368bc07e
+  metadata.gz: 69a1272b0938d590b72d8b94fcab0d37fdb6af71111e936e1e817a8acffca0c05a9907795027e796d081731a605b719e8999125d0124cb657996d95379340dd8
+  data.tar.gz: 7e26101b157dd1fcef0d061c3666a9c23402434667054a98e829f9969f8f1391e3c8c108d49220a7e8b9433b831b6507a4b543cbdb5a5c4b1334b456621292ea

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`.

data/fusuma-plugin-keypress.gemspec

@@ -1,28 +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"
+  }
 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,12 +1,26 @@
 # frozen_string_literal: true
 
+require "set"
+
 module Fusuma
   module Plugin
     module Detectors
       # Detect KeypressEvent from KeypressBuffer
       class KeypressDetector < Detector
-        SOURCES = ['keypress'].freeze
-        BUFFER_TYPE = 'keypress'
+        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?
@@ -17,28 +31,47 @@ 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),
+          return unless codes.any? { |code| MODIFIER_KEYS.include?(code) }
+
+          record = Events::Records::IndexRecord.new(
+            index: create_index(codes: codes),
             position: :surfix
           )
 
-          create_event(record: index_record)
+          create_event(record: record)
+        end
+
+        private
+
+        def find_buffer(buffers)
+          buffers.find { |b| b.type == BUFFER_TYPE }
+        end
+
+        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("keypress", skippable: true),
+              Config::Index::Key.new(codes.join("+"), skippable: true)
             ]
           )
         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,16 +1,62 @@
 # frozen_string_literal: true
 
+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
+          {
+            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.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,19 +5,7 @@ module Fusuma
     module Parsers
       # Generate KeypressRecord from libinput_command_input
       class KeypressParser < Parser
-        DEFAULT_SOURCE = 'libinput_command_input'
-
-        AVAILABLE_KEYS = %w[
-          CAPSLOCK
-          LEFTALT
-          LEFTCTRL
-          LEFTMETA
-          LEFTSHIFT
-          RIGHTALT
-          RIGHTCTRL
-          RIGHTSHIFT
-          RIGHTMETA
-        ].freeze
+        DEFAULT_SOURCE = "libinput_command_input"
 
         # @param record [String]
         # @return [Records::Gesture, nil]
@@ -36,17 +24,15 @@ 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
 
-            return unless AVAILABLE_KEYS.include?(code)
-
             Events::Records::KeypressRecord.new(status: status, code: code)
           end
         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.4.2
+  version: 0.6.1
 platform: ruby
 authors:
 - iberianpig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-03 00:00:00.000000000 Z
+date: 2022-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fusuma
@@ -43,14 +43,11 @@ 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/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 +63,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.26
 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
+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/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