fusuma-plugin-sendkey 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdbd450a3576a7faf3c331d4a79aa78e9d3d806ac91e884adf83828d479af826
-  data.tar.gz: faf882164080733d4c019590dff0052d4dcbb42780870fb616e3714ef29cfc19
+  metadata.gz: 4cf085cf00f878f5262bd4ef48d3e8ab49354bea02823c85c11e6edea79e9854
+  data.tar.gz: 718effb43a443bbb46852c851bf4716688a3e5bab413fa8a13ddda0f1cca1058
 SHA512:
-  metadata.gz: f78dde78d718f38b385f96301eaa23923d3225581473e4e523f93622142a33a64c24b228549c6b906a12917d7824b5162ed868e681c50e4fd7ca4143d6aea2d3
-  data.tar.gz: a3e6dcf360a8303faa9bbf89b7e3122571231fa614ef965189fd0a4b62de05a90fd6d826e74c2acc94aaed3de8d151c578d3eaee31bece54144f131492e7634c
+  metadata.gz: ea348132422cb7bab174e93eccabcd6df2ab358e5d282b619bd380e1a50452bc9c17021e046881cb256f9cb7ea3b30b2c752ba60f7e9be8b5bbe263ed9af7f04
+  data.tar.gz: 2a0e4eed20e056eff6708a7ce67c7015fd16ab85626c4729321328baaf7d6e27b25cc6509263a5c98630d37b41bb8a7a2d3c4a2e47f6225cfdf1bd2982030b6b

data/fusuma-plugin-sendkey.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |spec|
   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
+  # support bionic (18.04LTS) 2.5.1
 
   spec.add_dependency 'fusuma', '~> 2.0.0'
   spec.add_dependency 'revdev'

data/lib/fusuma/plugin/executors/sendkey_executor.rb

@@ -34,10 +34,7 @@ module Fusuma
         # @param event [Event]
         # @return [nil]
         def _execute(event)
-          keyboard.type(
-            param: search_param(event),
-            keep: search_keypress(event)
-          )
+          keyboard.type(param: search_param(event))
         end
 
         # check executable
@@ -62,15 +59,6 @@ module Fusuma
           index = Config::Index.new([*event.record.index.keys, :sendkey])
           Config.search(index)
         end
-
-        # @param event [Event]
-        # @return [String]
-        def search_keypress(event)
-          keys = event.record.index.keys
-          keypress_index = keys.find_index { |k| k.symbol == :keypress }
-          code = keypress_index && keys[keypress_index + 1].symbol
-          code.to_s
-        end
       end
     end
   end

data/lib/fusuma/plugin/sendkey/keyboard.rb

@@ -10,9 +10,25 @@ module Fusuma
     module Sendkey
       # Emulate Keyboard
       class Keyboard
+        MODIFIER_KEY_CODES = %w[
+          KEY_CAPSLOCK
+          KEY_LEFTALT
+          KEY_LEFTCTRL
+          KEY_LEFTMETA
+          KEY_LEFTSHIFT
+          KEY_RIGHTALT
+          KEY_RIGHTCTRL
+          KEY_RIGHTSHIFT
+          KEY_RIGHTMETA
+        ].freeze
+
+        def self.find_device(name_pattern:)
+          Fusuma::Device.all.find { |d| d.name.match(/#{name_pattern}/) }
+        end
+
         def initialize(name_pattern: nil)
           name_pattern ||= 'keyboard|Keyboard|KEYBOARD'
-          device = find_device(name_pattern: name_pattern)
+          device = Keyboard.find_device(name_pattern: name_pattern)
 
           if device.nil?
             warn "sendkey: Keyboard: /#{name_pattern}/ is not found"
@@ -26,16 +42,14 @@ module Fusuma
 
         # @param param [String]
         # @param keep [String]
-        def type(param:, keep: '')
+        def type(param:)
           return unless param.is_a?(String)
 
-          keep_keycodes = split_param(keep)
-          keycodes = split_param(param) - keep_keycodes
-
-          clear_modifiers(keep_keycodes)
-          keycodes.each { |keycode| key_event(keycode: keycode, press: true) }
+          param_keycodes = split_param(param)
+          clear_modifiers(MODIFIER_KEY_CODES - param_keycodes)
+          param_keycodes.each { |keycode| key_event(keycode: keycode, press: true) }
           key_sync(press: true)
-          keycodes.reverse.map { |keycode| key_event(keycode: keycode, press: false) }
+          param_keycodes.reverse.each { |keycode| key_event(keycode: keycode, press: false) }
           key_sync(press: false)
         end
 
@@ -101,19 +115,13 @@ module Fusuma
           Object.const_get "LinuxInput::#{keycode}"
         end
 
+        # @param [Array<String>] keycodes to be released
         def clear_modifiers(keycodes)
-          modifiers = %w[ CAPSLOCK LEFTALT LEFTCTRL LEFTMETA
-                          LEFTSHIFT RIGHTALT RIGHTCTRL RIGHTSHIFT ]
-                      .map { |code| key_prefix(code) }
-          (modifiers - keycodes).each { |code| key_event(keycode: code, press: false) }
+          keycodes.each { |code| key_event(keycode: code, press: false) }
         end
 
         private
 
-        def find_device(name_pattern:)
-          Fusuma::Device.all.find { |d| d.name.match(/#{name_pattern}/) }
-        end
-
         def split_param(param)
           param.split('+').map { |code| key_prefix(code) }
         end

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

@@ -3,7 +3,7 @@
 module Fusuma
   module Plugin
     module Sendkey
-      VERSION = '0.6.1'
+      VERSION = '0.6.2'
     end
   end
 end

data/spec/fusuma/plugin/executors/sendkey_executor_spec.rb

@@ -18,9 +18,6 @@ module Fusuma
               1:
                 direction:
                   sendkey: KEY_CODE
-                  keypress:
-                    LEFTSHIFT:
-                      sendkey: KEY_CODE_WITH_KEYPRESS
 
             plugin:
               executors:
@@ -37,9 +34,9 @@ module Fusuma
           index = Config::Index.new([:dummy, 1, :direction])
           record = Events::Records::IndexRecord.new(index: index)
           @event = Events::Event.new(tag: 'dummy_detector', record: record)
-          @executor = SendkeyExecutor.new
+          @executor = described_class.new
 
-          @keyboard = double(Sendkey::Keyboard)
+          @keyboard = instance_double(Sendkey::Keyboard)
 
           allow(@executor).to receive(:keyboard).and_return @keyboard
         end
@@ -49,6 +46,7 @@ module Fusuma
             allow(Process).to receive(:daemon).with(true)
             allow(Process).to receive(:detach).with(anything)
           end
+
           it 'fork' do
             expect(@executor).to receive(:fork).and_yield do |block_context|
               expect(block_context).to receive(:_execute).with(@event)
@@ -59,27 +57,10 @@ module Fusuma
         end
 
         describe '#_execute' do
-          after do
-            @executor._execute(@event)
-          end
           it 'send KEY_CODE message to keybard' do
-            expect(@executor).to receive(:search_param).with(@event).and_return('KEY_CODE')
-            expect(@executor).to receive(:search_keypress).with(@event).and_return(nil)
-            expect(@keyboard).to receive(:type).with(param: 'KEY_CODE', keep: nil)
-          end
-
-          context 'with keypress' do
-            before do
-              index_with_keypress = Config::Index.new(
-                [:dummy, 1, :direction, :keypress, :LEFTSHIFT]
-              )
-              record = Events::Records::IndexRecord.new(index: index_with_keypress)
-              @event = Events::Event.new(tag: 'dummy_detector', record: record)
-            end
-            it 'send KEY_CODE_WITH_KEYPRESS message to keybard' do
-              expect(@keyboard).to receive(:type)
-                .with(param: 'KEY_CODE_WITH_KEYPRESS', keep: 'LEFTSHIFT')
-            end
+            allow(@executor).to receive(:search_param).with(@event).and_return('KEY_CODE')
+            expect(@keyboard).to receive(:type).with(param: 'KEY_CODE')
+            @executor._execute(@event)
           end
         end
 
@@ -92,15 +73,17 @@ module Fusuma
             allow(@keyboard).to receive(:valid?).with(param: 'INVALID_CODE')
                                                 .and_return false
           end
+
           context 'when given valid event tagged as xxxx_detector' do
-            it { expect(@executor.executable?(@event)).to be_truthy }
+            it { expect(@executor).to be_executable(@event) }
           end
 
           context 'when given INVALID event tagged as invalid_tag' do
             before do
               @event.tag = 'invalid_tag'
             end
-            it { expect(@executor.executable?(@event)).to be_falsey }
+
+            it { expect(@executor).not_to be_executable(@event) }
           end
 
           context "when sendkey: 'MODIFIER_CODE+KEY_CODE'" do
@@ -121,8 +104,8 @@ module Fusuma
               Config.custom_path = nil
             end
 
-            it 'should return true' do
-              expect(@executor.executable?(@event)).to be_truthy
+            it 'returns true' do
+              expect(@executor).to be_executable(@event)
             end
           end
 
@@ -143,6 +126,10 @@ module Fusuma
 
               Config.custom_path = nil
             end
+
+            it 'returns true' do
+              expect(@executor).not_to be_executable(@event)
+            end
           end
         end
       end

data/spec/fusuma/plugin/sendkey/keyboard_spec.rb

@@ -9,62 +9,62 @@ module Fusuma
     module Sendkey
       RSpec.describe Keyboard do
         describe '#new' do
-          context 'keyboard is found' do
+          context 'when keyboard is found' do
             before do
               dummy_keyboard = Fusuma::Device.new(name: 'dummy keyboard')
-              allow_any_instance_of(Sendkey::Keyboard)
+              allow(described_class)
                 .to receive(:find_device)
                 .and_return(dummy_keyboard)
               allow(Sendkey::Device).to receive(:new).and_return('dummy')
             end
 
-            it 'should not raise error' do
-              expect { Keyboard.new }.not_to raise_error
+            it 'does not raise error' do
+              expect { described_class.new }.not_to raise_error
             end
           end
 
-          context 'keyboard is not found' do
+          context 'when keyboard is not found' do
             before do
-              allow_any_instance_of(Sendkey::Keyboard)
+              allow(described_class)
                 .to receive(:find_device)
                 .and_return(nil)
             end
 
-            it 'should not raise error' do
-              expect { Keyboard.new }.to raise_error SystemExit
+            it 'does not raise error' do
+              expect { described_class.new }.to raise_error SystemExit
             end
           end
 
-          context 'detected device name is Keyboard (Capitarized)' do
+          context 'when detected device name is Keyboard (Capitarized)' do
             before do
               other_device = Fusuma::Device.new(name: 'Keyboard', id: 'dummy')
 
-              allow_any_instance_of(Sendkey::Keyboard)
+              allow(described_class)
                 .to receive(:find_device)
                 .and_return(other_device)
               allow(Sendkey::Device).to receive(:new).and_return('dummy')
             end
 
-            it 'should not raise error' do
-              expect { Keyboard.new }.not_to raise_error
+            it 'does not raise error' do
+              expect { described_class.new }.not_to raise_error
             end
           end
 
-          context 'detected device name is KEYBOARD (Upper case)' do
+          context 'when detected device name is KEYBOARD (Upper case)' do
             before do
               other_device = Fusuma::Device.new(name: 'KEYBOARD', id: 'dummy')
-              allow_any_instance_of(Sendkey::Keyboard)
+              allow(described_class)
                 .to receive(:find_device)
                 .and_return(other_device)
               allow(Sendkey::Device).to receive(:new).and_return('dummy')
             end
 
-            it 'should not raise error' do
-              expect { Keyboard.new }.not_to raise_error
+            it 'does not raise error' do
+              expect { described_class.new }.not_to raise_error
             end
           end
 
-          context 'given name pattern' do
+          context 'with given name pattern' do
             before do
               specified_device = Fusuma::Device.new(
                 name: 'Awesome KEY/BOARD input device',
@@ -74,18 +74,19 @@ module Fusuma
               allow(Sendkey::Device).to receive(:new).and_return('dummy')
             end
 
-            it 'should not raise error' do
-              expect { Keyboard.new(name_pattern: 'Awesome KEY/BOARD') }.not_to raise_error
+            it 'does not raise error' do
+              expect { described_class.new(name_pattern: 'Awesome KEY/BOARD') }.not_to raise_error
             end
           end
 
-          context 'not given name pattern (use default)' do
-            subject { -> { Keyboard.new(name_pattern: nil) } }
+          context 'when name pattern (use default) is not given' do
+            subject { -> { described_class.new(name_pattern: nil) } }
+
             before do
               allow(Sendkey::Device).to receive(:new).and_return('dummy')
             end
 
-            context 'exist device named keyboard' do
+            context 'when exist device named keyboard(lower-case)' do
               before do
                 specified_device = Fusuma::Device.new(
                   name: 'keyboard',
@@ -97,7 +98,7 @@ module Fusuma
               it { is_expected.not_to raise_error }
             end
 
-            context 'exist device named Keyboard' do
+            context 'when exist device named Keyboard(Capital-case)' do
               before do
                 specified_device = Fusuma::Device.new(
                   name: 'Keyboard',
@@ -109,7 +110,7 @@ module Fusuma
               it { is_expected.not_to raise_error }
             end
 
-            context 'exist device named KEYBOARD' do
+            context 'when exist device named KEYBOARD(UPPER case)' do
               before do
                 specified_device = Fusuma::Device.new(
                   name: 'KEYBOARD',
@@ -121,7 +122,7 @@ module Fusuma
               it { is_expected.not_to raise_error }
             end
 
-            context 'exist no device named keyboard|Keyboard|KEYBOARD' do
+            context 'when exist no device named keyboard|Keyboard|KEYBOARD' do
               before do
                 specified_device = Fusuma::Device.new(
                   name: 'KEY-BOARD',
@@ -137,20 +138,20 @@ module Fusuma
 
         describe '#type' do
           before do
-            allow_any_instance_of(Sendkey::Keyboard)
+            allow(described_class)
               .to receive(:find_device)
               .and_return(Fusuma::Device.new(name: 'dummy keyboard'))
 
-            @device = double(Sendkey::Device)
+            @device = instance_double(Sendkey::Device)
             allow(@device).to receive(:write_event).with(anything)
             # allow(@device).to receive(:valid?).with(param: 'KEY_A')
 
             allow(Sendkey::Device).to receive(:new).and_return(@device)
 
-            @keyboard = Keyboard.new
+            @keyboard = described_class.new
           end
 
-          it 'should press key KEY_A and release KEY_A' do
+          it 'presses key KEY_A and release KEY_A' do
             expect(@keyboard).to receive(:clear_modifiers).ordered
             expect(@keyboard).to receive(:key_event).with(keycode: 'KEY_A', press: true).ordered
             expect(@keyboard).to receive(:key_event).with(keycode: 'KEY_A', press: false).ordered
@@ -162,7 +163,12 @@ module Fusuma
               @keys = 'LEFTSHIFT+A'
             end
 
-            it 'should type AB' do
+            it 'clear all modifier keys except parameter of sendkey' do
+              expect(@keyboard).to receive(:clear_modifiers).with(Keyboard::MODIFIER_KEY_CODES - ['KEY_LEFTSHIFT']).ordered
+              @keyboard.type(param: @keys)
+            end
+
+            it 'types (Shift)A' do
               expect(@keyboard).to receive(:clear_modifiers).ordered
               expect(@keyboard).to receive(:key_event).with(keycode: 'KEY_LEFTSHIFT', press: true).ordered
               expect(@keyboard).to receive(:key_event).with(keycode: 'KEY_A', press: true).ordered
@@ -171,12 +177,13 @@ module Fusuma
               @keyboard.type(param: @keys)
             end
           end
+
           context 'with multiple keys' do
             before do
               @keys = 'A+B'
             end
 
-            it 'should type AB' do
+            it 'types AB' do
               expect(@keyboard).to receive(:clear_modifiers).ordered
               expect(@keyboard).to receive(:key_event).with(keycode: 'KEY_A', press: true).ordered
               expect(@keyboard).to receive(:key_event).with(keycode: 'KEY_B', press: true).ordered
@@ -185,18 +192,6 @@ module Fusuma
               @keyboard.type(param: @keys)
             end
           end
-          context 'with keypress' do
-            before do
-              @keys = 'LEFTSHIFT+A'
-              @keypress_keys = 'LEFTSHIFT'
-            end
-            it 'should type A (without LEFTSHIFT key pressing by user)' do
-              expect(@keyboard).to receive(:clear_modifiers).ordered
-              expect(@keyboard).to receive(:key_event).with(keycode: 'KEY_A', press: true).ordered
-              expect(@keyboard).to receive(:key_event).with(keycode: 'KEY_A', press: false).ordered
-              @keyboard.type(param: @keys, keep: @keypress_keys)
-            end
-          end
         end
       end
     end

data/spec/helpers/config_helper.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'tempfile'
-require 'fusuma/config.rb'
+require 'fusuma/config'
 
 module Fusuma
   module ConfigHelper

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'helpers/config_helper.rb'
+require 'helpers/config_helper'
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma-plugin-sendkey
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - iberianpig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-13 00:00:00.000000000 Z
+date: 2021-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fusuma
@@ -74,7 +74,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="