fusuma-plugin-sendkey 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23d68a2efd5f41fe72149b824d2ccb15d9153b70e177e0c6547c6fdc531d7015
-  data.tar.gz: 206d32b21db53813a0213aa6efa7f4005132332ad06f5d360bb57aed291bd61c
+  metadata.gz: 707d75db2c999853574d86dc395d0b95fdef3ca57a734bc50dbafedb02170eb5
+  data.tar.gz: 8842a7e50e1e20ac502a46da93b30d67449e0073cc4e31483db1eaa248119b52
 SHA512:
-  metadata.gz: d8565fdb87ae1ed53a903587c45fc529b780983e845be2f81601e72160244de3852fdc63d8d1f9960cb20c30b82e86713a4c56c393064cf67e04548f1c187323
-  data.tar.gz: 84f81cc005e1cfe105844f0108241a8e4c2c99f454a2ae5dbfa52023c4c094efb534f87f7c6f6705647b5f4fd556387c8d3ef6def58a6141c39cc94faa6dd6a2
+  metadata.gz: 0c484ac88ad76c780c2a9f5eb4c787c121f3c5078aae3dc8167ffed1b369cd97e63105d14e5a192fda1a3bf0c000abf9edcf4c0457bdee8358b7350545b722c3
+  data.tar.gz: 5c02dea7596324a16efc5010c25bbeb3cab7188d0e2065b78fa429419035246d8a2cd4b238de78a12cf6537f59e8329743c8abc30e8d8013fcd1a78af6700332

data/.rubocop.yml

@@ -1,3 +1,7 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  NewCops: enable
+
 Metrics/ModuleLength:
   Exclude:
     - "**/*_spec.rb"
@@ -7,7 +11,15 @@ Metrics/BlockLength:
     - "**/*_spec.rb"
     - "fusuma-plugin-*.gemspec"
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 100
   Exclude:
+    - "**/*_spec.rb"
     - "fusuma-plugin-*.gemspec"
+
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true

data/CHANGELOG.md

@@ -1,8 +1,16 @@
 # Changelog
 
-## [Unreleased](https://github.com/iberianpig/fusuma-plugin-keypress/tree/HEAD)
+## [v0.2.1](https://github.com/iberianpig/fusuma-plugin-keypress/tree/v0.2.1) (2020-04-15)
 
-[Full Changelog](https://github.com/iberianpig/fusuma-plugin-keypress/compare/v0.1.1...HEAD)
+[Full Changelog](https://github.com/iberianpig/fusuma-plugin-keypress/compare/v0.2.0...v0.2.1)
+
+**Closed issues:**
+
+- Only 'LEFTMETA' keycode works on KDE Plasma [\#2](https://github.com/iberianpig/fusuma-plugin-keypress/issues/2)
+
+## [v0.2.0](https://github.com/iberianpig/fusuma-plugin-keypress/tree/v0.2.0) (2020-03-18)
+
+[Full Changelog](https://github.com/iberianpig/fusuma-plugin-keypress/compare/v0.1.1...v0.2.0)
 
 **Closed issues:**
 

data/Gemfile

@@ -2,3 +2,15 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in fusuma-plugin-sendkey.gemspec
 gemspec
+
+gem 'bundler'
+gem 'github_changelog_generator', '~> 1.14'
+gem 'lefthook'
+gem 'pry-byebug', '~> 3.4'
+gem 'pry-doc'
+gem 'pry-inline'
+gem 'rake', '~> 13.0'
+gem 'reek'
+gem 'rspec', '~> 3.0'
+gem 'rubocop'
+gem 'yard'

data/README.md

@@ -2,43 +2,69 @@
 
 [Fusuma](https://github.com/iberianpig/fusuma) plugin to send keyboard events
 
-* Emulate keyboard events with evdev
-* This plugin is wayland compatible and alternative to xdotool
+* Low-latency key event emulation with evdev
+* Alternative to xdotool available for X11 and Wayland
 
 ## Installation
 
 Run the following code in your terminal.
 
-### Install dependencies
+### 1. Install dependencies
 
+#### For Debian Based Distros (Ubuntu, Debian, Mint, Pop!_OS)
+
+**NOTE: If you have installed ruby by apt, you must install ruby-dev.**
 ```sh
-$ sudo apt-get install libevdev-dev
+$ sudo apt-get install libevdev-dev ruby-dev build-essential
+```
+
+#### For Arch Based Distros (Manjaro, Arch)
+
+```zsh
+$ sudo pacman -S libevdev base-devel
 ```
 
-### Install fusuma-plugin-sendkey
+### 2. Install fusuma-plugin-sendkey
+
+
+**Note For Arch Based Distros:** By default in Arch Linux, when running ```gem```, gems are installed per-user (into ```~/.gem/ruby/```), instead of system-wide (into ```/usr/lib/ruby/gems/```). This is considered the best way to manage gems on Arch, because otherwise they might interfere with gems installed by Pacman. (From Arch Wiki)
+
+To install gems system-wide, see any of the methods listed on [Arch Wiki](https://wiki.archlinux.org/index.php/ruby#Installing_gems_system-wide)
+
 
 ```sh
+$ sudo gem install revdev
+$ sudo gem install bundler
 $ sudo gem install fusuma-plugin-sendkey
 ```
 
-
 ## 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` command is available on your terminal
-* `fusuma-sendkey` can send multiple key events
-* Combine keys for pressing the same time with `+` 
+* `fusuma-sendkey` supports modifier keys and multiple key presses.
+Combine keys for pressing the same time with `+` 
 
 
 ```sh
 $ 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
 
@@ -59,6 +85,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/exe/fusuma-sendkey

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require 'optparse'
+require 'fusuma/plugin/inputs/libinput_command_input.rb'
 require_relative '../lib/fusuma/plugin/sendkey/keyboard.rb'
 require_relative '../lib/fusuma/plugin/sendkey/version.rb'
 

data/fusuma-plugin-sendkey.gemspec

@@ -24,17 +24,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'fusuma', '~> 1.7'
+  spec.add_dependency 'fusuma', '~> 2.0.0'
   spec.add_dependency 'revdev'
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'github_changelog_generator', '~> 1.14'
-  spec.add_development_dependency 'pry-byebug', '~> 3.4'
-  spec.add_development_dependency 'pry-doc'
-  spec.add_development_dependency 'pry-inline'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'reek'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'yard'
 end

data/lefthook.yml

@@ -0,0 +1,29 @@
+# EXAMPLE USAGE
+# Refer for explanation to following link:
+# https://github.com/Arkweid/lefthook/blob/master/docs/full_guide.md
+
+# pre-push:
+#   commands:
+#     packages-audit:
+#       tags: frontend security
+#       run: yarn audit
+#     gems-audit:
+#       tags: backend security
+#       run: bundle audit
+
+pre-commit:
+  parallel: true
+  commands:
+    # eslint:
+    #   glob: "*.{js,ts}"
+    #   run: yarn eslint {staged_files}
+    rubocop:
+      tags: backend style
+      glob: "*.rb"
+      # exclude: "application.rb|routes.rb"
+      run: bundle exec rubocop --force-exclusion {staged_files}
+  # scripts:
+  #   "hello.js":
+  #     runner: node
+  #   "any.go":
+  #     runner: go run

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

@@ -1,31 +1,45 @@
 # frozen_string_literal: true
 
-require_relative '../sendkey/keyboard.rb'
+require_relative '../sendkey/keyboard'
 
 module Fusuma
   module Plugin
     module Executors
       # Control Window or Workspaces by executing wctrl
       class SendkeyExecutor < Executor
+        def execute_keys
+          [:sendkey]
+        end
+
         def config_param_types
           {
-            'device_name': String
+            device_name: String
           }
         end
 
-        # execute sendkey command
+        # fork and execute sendkey command
         # @param event [Event]
         # @return [nil]
         def execute(event)
           MultiLogger.info(sendkey: search_param(event))
           pid = fork do
             Process.daemon(true)
-            keyboard.type(param: search_param(event))
+            _execute(event)
           end
 
           Process.detach(pid)
         end
 
+        # execute sendkey command
+        # @param event [Event]
+        # @return [nil]
+        def _execute(event)
+          keyboard.type(
+            param: search_param(event),
+            keep: search_keypress(event)
+          )
+        end
+
         # check executable
         # @param event [Event]
         # @return [TrueClass, FalseClass]
@@ -39,15 +53,24 @@ module Fusuma
 
         def keyboard
           @keyboard ||= begin
-                          name_pattren = config_params(:device_name)
-                          Sendkey::Keyboard.new(name_pattern: name_pattren)
-                        end
+            name_pattren = config_params(:device_name)
+            Sendkey::Keyboard.new(name_pattern: name_pattren)
+          end
         end
 
         def search_param(event)
           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/device.rb

@@ -10,7 +10,7 @@ module Fusuma
         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

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

@@ -3,7 +3,7 @@
 require 'revdev'
 require 'fusuma/device'
 
-require_relative './device.rb'
+require_relative './device'
 
 module Fusuma
   module Plugin
@@ -11,26 +11,28 @@ module Fusuma
       # Emulate Keyboard
       class Keyboard
         def initialize(name_pattern: nil)
-          name_pattern ||= 'keyboard'
+          name_pattern ||= 'keyboard|Keyboard|KEYBOARD'
           device = find_device(name_pattern: name_pattern)
 
           if device.nil?
-            warn "sendkey: Keyboard /#{name_pattern}/ is not found"
+            warn "sendkey: Keyboard: /#{name_pattern}/ is not found"
             exit(1)
           end
 
           @device = Device.new(path: "/dev/input/#{device.id}")
         end
 
-        attr_writer :device
+        attr_reader :device
 
         # @param param [String]
-        def type(param:)
+        # @param keep [String]
+        def type(param:, keep: '')
           return unless param.is_a?(String)
 
-          keycodes = split_param(param)
+          keep_keycodes = split_param(keep)
+          keycodes = split_param(param) - keep_keycodes
 
-          clear_modifiers
+          clear_modifiers(keep_keycodes)
           keycodes.each { |keycode| key_event(keycode: keycode, press: true) }
           key_sync(press: true)
           keycodes.reverse.map { |keycode| key_event(keycode: keycode, press: false) }
@@ -99,10 +101,11 @@ module Fusuma
           Object.const_get "LinuxInput::#{keycode}"
         end
 
-        def clear_modifiers
+        def clear_modifiers(keycodes)
           modifiers = %w[ CAPSLOCK LEFTALT LEFTCTRL LEFTMETA
                           LEFTSHIFT RIGHTALT RIGHTCTRL RIGHTSHIFT ]
-          modifiers.each { |code| key_event(keycode: key_prefix(code), press: false) }
+                      .map { |code| key_prefix(code) }
+          (modifiers - keycodes).each { |code| key_event(keycode: code, press: false) }
         end
 
         private

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

@@ -3,7 +3,7 @@
 module Fusuma
   module Plugin
     module Sendkey
-      VERSION = '0.4.0'
+      VERSION = '0.6.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma-plugin-sendkey
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - iberianpig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-25 00:00:00.000000000 Z
+date: 2021-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fusuma
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: revdev
   requirement: !ruby/object:Gem::Requirement
@@ -38,146 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: github_changelog_generator
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: pry-doc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-inline
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Fusuma::Plugin::Sendkey emulate keyboard events with evdev
 email:
 - yhkyky@gmail.com
@@ -200,6 +60,7 @@ files:
 - bin/setup
 - exe/fusuma-sendkey
 - fusuma-plugin-sendkey.gemspec
+- lefthook.yml
 - lib/fusuma/plugin/executors/sendkey_executor.rb
 - lib/fusuma/plugin/sendkey.rb
 - lib/fusuma/plugin/sendkey/device.rb
@@ -224,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Fusuma plugin to send keyboard events