fusuma-plugin-sendkey 0.1.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3087cd15e356a48d1f8fd2398daed7f6153d4e9c005db98ffad34627b357bc65
-  data.tar.gz: 0dd9da2ff1ef200d76691f9a3e72fe8efff68cea8e6eef1c448387df6154daf1
+  metadata.gz: e1f133065105c5e8bcdc9dd04873d6245cb3b6357a1a9f45a437cd0150b5a959
+  data.tar.gz: c6f759e41f007688902c837f1fedc65e00d70ee3a41bb8bc9baf28de48e3c8ed
 SHA512:
-  metadata.gz: 830a41f20bfa018ceff548a8c660012947657fbd18b8e369a1033fb4f4d0e2f665ade047eeafa9d3ba3ade8ba5079a1c1044cc6401b4222da20847bced619a7b
-  data.tar.gz: 9f8ae60d5377799ed80844ba3a218049c1a736cf7ed0e733dea347067a30fc548f6aa5c82b2311858e2474f8ad0d1df8a3e8739730d9e301664a784d2a073b26
+  metadata.gz: 6390589b886bc137bed6e4bbd4cab68b890d7660fbf09462aa471557c8c7533cff11f73cec2f25ce3875489ef3abd44e82999af2f400dbe619470f29e4d2e17b
+  data.tar.gz: 4f80040d29ff16b5184e2f2f51485e39e178a029da0aec8e2c647da9428bd08ab54f5814c49194eeccdfac012091e4235392768d02de71191fff8af3b9bf4f4f

data/.gitignore

@@ -10,3 +10,4 @@
 
 # rspec failure tracking
 .rspec_status
+.ruby-version

data/.rubocop.yml

@@ -11,3 +11,10 @@ Metrics/LineLength:
   Max: 100
   Exclude:
     - "fusuma-plugin-*.gemspec"
+
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true

data/.travis.yml

@@ -6,4 +6,4 @@ rvm:
   - 2.6.1
 before_install: 
  - gem install bundler -v 2.0.1
- - sudo apt-get -y install evemu-tools libevdev-dev
+ - sudo apt-get -y install libevdev-dev

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+## [Unreleased](https://github.com/iberianpig/fusuma-plugin-keypress/tree/HEAD)
+
+[Full Changelog](https://github.com/iberianpig/fusuma-plugin-keypress/compare/v0.1.1...HEAD)
+
+**Closed issues:**
+
+- Trigger a command multiple times while keeping the key pressed [\#1](https://github.com/iberianpig/fusuma-plugin-keypress/issues/1)
+
+## [v0.1.1](https://github.com/iberianpig/fusuma-plugin-keypress/tree/v0.1.1) (2020-02-18)
+
+[Full Changelog](https://github.com/iberianpig/fusuma-plugin-keypress/compare/v0.1.0...v0.1.1)
+
+## [v0.1.0](https://github.com/iberianpig/fusuma-plugin-keypress/tree/v0.1.0) (2019-11-12)
+
+[Full Changelog](https://github.com/iberianpig/fusuma-plugin-keypress/compare/fb8d8ccfc3828e487607706335f670ae5392f08d...v0.1.0)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/README.md

@@ -1,9 +1,9 @@
 # Fusuma::Plugin::Sendkey [![Gem Version](https://badge.fury.io/rb/fusuma-plugin-sendkey.svg)](https://badge.fury.io/rb/fusuma-plugin-sendkey) [![Build Status](https://travis-ci.com/iberianpig/fusuma-plugin-sendkey.svg?branch=master)](https://travis-ci.com/iberianpig/fusuma-plugin-sendkey)
 
-[Fusuma](https://github.com/iberianpig/fusuma) plugin that sending virtual keyboard events
+[Fusuma](https://github.com/iberianpig/fusuma) plugin to send keyboard events
 
-* Emulate keyboard events with evemu-event
-* This plugin replaces xdotool
+* Low-latency key event emulation with evdev
+* Alternative to xdotool available for X11 and Wayland
 
 ## Installation
 
@@ -11,33 +11,45 @@ Run the following code in your terminal.
 
 ### Install dependencies
 
+**NOTE: If you have installed ruby by apt, you must install ruby-dev.**
 ```sh
-$ sudo apt-get install evemu-tools libevdev-dev
+$ sudo apt-get install libevdev-dev ruby-dev
 ```
 
 ### Install fusuma-plugin-sendkey
 
 ```sh
-$ gem install fusuma-plugin-sendkey
+$ sudo gem install fusuma-plugin-sendkey
 ```
 
 
-## List avaiable keys
+## List available keys
 
 ```sh
 $ fusuma-sendkey -l
 ```
+If you want to look up a specific key, like the next song or the previous song, the `grep -i` refinement search is useful.
+
+```sh
+$ fusuma-sendkey -l | grep -i song
+NEXTSONG
+PREVIOUSSONG
+```
 
 ## Run fusuma-sendkey on Terminal
 
-* `fusuma-sendkey` can emulate keyboard inputs as a command
-* Combine keys for pressing the same time with `+` 
+* `fusuma-sendkey` command is available on your terminal
+* `fusuma-sendkey` supports modifier keys and multiple key presses.
+Combine keys for pressing the same time with `+` 
 
 
 ```sh
-$ fusuma-sendkey LEFTCTRL+T
+$ fusuma-sendkey LEFTCTRL+T # press ctrl key + t key
 ```
 
+Some of the keys found with `fusuma-sendkey -l` may actually be invalid keys.
+So test it once with `fusuma-sendkey <KEYCODE>` and then add it to config.yml.
+
 
 ## Add sendkey properties to config.yml
 
@@ -58,6 +70,26 @@ swipe:
       sendkey: "LEFTCTRL+W" # close tab
 ```
 
+
+### Specify keyboard by device name
+
+If you got following error message, try to set your keyboard name to `plugin.executors.sendkey_executor.device_name` on config.yml
+
+```shell
+$ fusuma-sendkey -l
+sendkey: Keyboard: /keyboard|Keyboard|KEYBOARD/ is not found
+```
+
+Set the following options to recognize keyboard only for the specified keyboard device.
+Open `~/.config/fusuma/config.yml` and add the following code at the bottom.
+
+```yaml
+plugin:
+  executors:
+    sendkey_executor:
+      device_name: 'YOUR KEYBOARD NAME'
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/iberianpig/fusuma-plugin-sendkey. 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/Rakefile

@@ -1,6 +1,15 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
+
+require 'github_changelog_generator/task'
+
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.user = 'iberianpig'
+  config.project = 'fusuma-plugin-keypress'
+end

data/bin/console

@@ -1,14 +1,12 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
+require 'fusuma/plugin/executors/executor'
 require "fusuma/plugin/sendkey"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+require "pry"
+Pry.start

data/exe/fusuma-sendkey

@@ -3,6 +3,7 @@
 
 require 'optparse'
 require_relative '../lib/fusuma/plugin/sendkey/keyboard.rb'
+require_relative '../lib/fusuma/plugin/sendkey/version.rb'
 
 option = {}
 opt = OptionParser.new
@@ -19,7 +20,7 @@ end
 opt.parse!(ARGV)
 
 if option[:list]
-  puts Keyboard.new.available_codes
+  puts Fusuma::Plugin::Sendkey::Keyboard.new(name_pattern: nil).search_codes
   return
 end
 
@@ -36,6 +37,5 @@ if param.nil?
   exit 1
 end
 
-Keyboard.new.type_command(param: param).tap do |command|
-  exec(command)
-end
+keyboard = Fusuma::Plugin::Sendkey::Keyboard.new
+keyboard.valid?(param: param) && keyboard.type(param: param)

data/fusuma-plugin-sendkey.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['iberianpig']
   spec.email         = ['yhkyky@gmail.com']
 
-  spec.summary       = 'Fusuma plugin that sending virtual keyboard events'
-  spec.description   = 'Fusuma::Plugin::Sendkey emulate keyboard events with evemu-event'
+  spec.summary       = 'Fusuma plugin to send keyboard events'
+  spec.description   = 'Fusuma::Plugin::Sendkey emulate keyboard events with evdev'
   spec.homepage      = 'https://github.com/iberianpig/fusuma-plugin-sendkey'
   spec.license       = 'MIT'
 
@@ -24,8 +24,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'evdev'
-  spec.add_dependency 'fusuma', '~> 1.5.0'
+  spec.add_dependency 'fusuma', '~> 1.7'
+  spec.add_dependency 'revdev'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'github_changelog_generator', '~> 1.14'

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

@@ -9,7 +9,7 @@ module Fusuma
       class SendkeyExecutor < Executor
         def config_param_types
           {
-            'device_path': String
+            'device_name': String
           }
         end
 
@@ -17,12 +17,10 @@ module Fusuma
         # @param event [Event]
         # @return [nil]
         def execute(event)
-          return if search_command(event).nil?
-
           MultiLogger.info(sendkey: search_param(event))
           pid = fork do
             Process.daemon(true)
-            exec(search_command(event))
+            keyboard.type(param: search_param(event))
           end
 
           Process.detach(pid)
@@ -34,22 +32,18 @@ module Fusuma
         def executable?(event)
           event.tag.end_with?('_detector') &&
             event.record.type == :index &&
-            search_command(event)
+            keyboard.valid?(param: search_param(event))
         end
 
-        # @param event [Event]
-        # @return [String]
-        # @return [NilClass]
-        def search_command(event)
+        private
+
+        def keyboard
           @keyboard ||= begin
-                          device = Sendkey::Device.new(path: config_params(:device_path))
-                          Sendkey::Keyboard.new(device: device)
+                          name_pattren = config_params(:device_name)
+                          Sendkey::Keyboard.new(name_pattern: name_pattren)
                         end
-          @keyboard.type_command(param: search_param(event))
         end
 
-        private
-
         def search_param(event)
           index = Config::Index.new([*event.record.index.keys, :sendkey])
           Config.search(index)

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

@@ -1,62 +1,22 @@
 # frozen_string_literal: true
 
-require 'evdev'
-
 module Fusuma
   module Plugin
     module Sendkey
       # handle Evdev device
       class Device
-        attr_reader :device_id
-        def initialize(path: nil)
-          return if path && (@evdev = Evdev.new(path))
-
-          (0..99).lazy.find do |i|
-            begin
-              evdev = Evdev.new("/dev/input/event#{i}")
-              @evdev = evdev if evdev.supports_event?(convert_keycode('LEFTALT'))
-            rescue Errno::ENOENT # No such file or directory
-              false
-              # TODO: rescue Errno::EACCES
-            end
-          end
+        def initialize(path:)
+          @evdev = Revdev::EventDevice.new(path)
         end
 
         def path
-          raise 'Keyboard is not found' if @evdev.nil?
+          raise 'Device path is not found' if @evdev.nil?
 
           @path ||= @evdev.file.path
         end
 
-        def support?(code)
-          keycode = convert_keycode(code)
-          @evdev.supports_event?(keycode)
-        rescue NameError
-          candidates = search_codes(code: code)
-
-          warn "Did you mean? #{candidates.join(' / ')}" unless candidates.empty?
-
-          false
-        end
-
-        def search_codes(code: nil)
-          query = code&.upcase
-          LinuxInput.constants
-                    .select { |c| c[/KEY_.*#{query}.*/] }
-                    .select { |c| @evdev.supports_event?(c) }
-                    .map { |c| c.to_s.gsub('KEY_', '') }
-        end
-
-        def emulate(code:, press: true)
-          keycode = convert_keycode(code)
-          v = press ? 1 : 0
-          "evemu-event #{path} --type EV_KEY --code #{keycode} --value #{v} --sync"
-        end
-
-        private
-
-        def convert_keycode(code)
-          "KEY_#{code.upcase}"
+        def write_event(event)
+          @evdev.write_input_event(event)
         end
       end
     end

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

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'revdev'
+require 'fusuma/device'
+
 require_relative './device.rb'
 
 module Fusuma
@@ -7,46 +10,116 @@ module Fusuma
     module Sendkey
       # Emulate Keyboard
       class Keyboard
-        def initialize(device: nil)
-          @device = device || Device.new
+        def initialize(name_pattern: 'keyboard|Keyboard|KEYBOARD')
+          device = find_device(name_pattern: name_pattern)
+
+          if device.nil?
+            warn "sendkey: Keyboard: /#{name_pattern}/ is not found"
+            exit(1)
+          end
+
+          @device = Device.new(path: "/dev/input/#{device.id}")
         end
 
+        attr_reader :device
+
         # @param param [String]
-        def type_command(param:)
+        def type(param:)
           return unless param.is_a?(String)
 
-          codes = param.split('+')
-          press_commands = codes.map { |code| press_command(code) }
-          release_commands = codes.reverse.map { |code| release_command(code) }
+          keycodes = split_param(param)
 
-          (press_commands | release_commands).join(' && ')
+          clear_modifiers
+          keycodes.each { |keycode| key_event(keycode: keycode, press: true) }
+          key_sync(press: true)
+          keycodes.reverse.map { |keycode| key_event(keycode: keycode, press: false) }
+          key_sync(press: false)
         end
 
-        def press_command(code)
-          return unless support?(code)
+        # @param param [String]
+        def valid?(param:)
+          return unless param.is_a?(String)
 
-          @device.emulate(code: code, press: true)
+          keycodes = split_param(param)
+          keycodes.all? { |keycode| support?(keycode) }
         end
 
-        def release_command(code)
-          return unless support?(code)
+        def key_event(keycode:, press: true)
+          event = Revdev::InputEvent.new(
+            nil,
+            Revdev.const_get(:EV_KEY),
+            Revdev.const_get(keycode),
+            press ? 1 : 0
+          )
+          @device.write_event(event)
+        end
 
-          @device.emulate(code: code, press: false)
+        def key_sync(press: true)
+          event = Revdev::InputEvent.new(
+            nil,
+            Revdev.const_get(:EV_SYN),
+            Revdev.const_get(:SYN_REPORT),
+            press ? 1 : 0
+          )
+          @device.write_event(event)
         end
 
-        def support?(code)
+        def support?(keycode)
           @supported_code ||= {}
-          @supported_code[code] ||= if @device.support?(code)
-                                      true
-                                    else
-                                      warn "sendkey: #{code} is unsupported."
-                                      warn 'Please check your config.yml.'
-                                      exit 1
-                                    end
+          @supported_code[keycode] ||= if find_code(keycode: keycode)
+                                         true
+                                       else
+                                         search_candidates(keycode: keycode)
+                                       end
+        end
+
+        def search_candidates(keycode:)
+          query = keycode&.upcase&.gsub('KEY_', '')
+
+          candidates = search_codes(query: query)
+
+          warn "Did you mean? #{candidates.join(' / ')}" unless candidates.empty?
+          warn "sendkey: #{remove_prefix(keycode)} is unsupported."
+        end
+
+        def search_codes(query: nil)
+          Revdev.constants
+                .select { |c| c[/KEY_.*#{query}.*/] }
+                .map { |c| c.to_s.gsub('KEY_', '') }
+        end
+
+        def find_code(keycode: nil)
+          query = keycode&.upcase&.gsub('KEY_', '')
+
+          Revdev.constants.find { |c| c == "KEY_#{query}".to_sym }
+        end
+
+        def keycode_const(keycode)
+          Object.const_get "LinuxInput::#{keycode}"
+        end
+
+        def clear_modifiers
+          modifiers = %w[ CAPSLOCK LEFTALT LEFTCTRL LEFTMETA
+                          LEFTSHIFT RIGHTALT RIGHTCTRL RIGHTSHIFT ]
+          modifiers.each { |code| key_event(keycode: key_prefix(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
+
+        def key_prefix(code)
+          "KEY_#{code.upcase}"
         end
 
-        def available_codes
-          @device.search_codes
+        def remove_prefix(keycode)
+          keycode.gsub('KEY_', '')
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module Fusuma
   module Plugin
     module Sendkey
-      VERSION = '0.1.1'
+      VERSION = '0.5.0'
     end
   end
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: fusuma-plugin-sendkey
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.5.0
 platform: ruby
 authors:
 - iberianpig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-03 00:00:00.000000000 Z
+date: 2020-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: evdev
+  name: fusuma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: fusuma
+  name: revdev
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -178,7 +178,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Fusuma::Plugin::Sendkey emulate keyboard events with evemu-event
+description: Fusuma::Plugin::Sendkey emulate keyboard events with evdev
 email:
 - yhkyky@gmail.com
 executables:
@@ -190,6 +190,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -226,5 +227,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Fusuma plugin that sending virtual keyboard events
+summary: Fusuma plugin to send keyboard events
 test_files: []