fusuma-plugin-sendkey 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44727a1c5bc946a741238fbe69dc69f7251de60f8d7d27b76c37c6785cfc1870
-  data.tar.gz: 8da2b282e60c73ecd4db5e9907ee41b9e2e3ae64a04e0cee96fa36583f593c8a
+  metadata.gz: 9e094c69745660103650d6670883009eceaa0a879e724319997bbfed547d893c
+  data.tar.gz: 627342211f6fd7b333c255264f62766ee2324fbafe3e4682005f9ac10fbfd948
 SHA512:
-  metadata.gz: d880dcfa24cb1545aba87ef3af69a8139e907cba32145b84c4e3ff310a7d856f2bd8af536e9071887e3cbc77e72628365bf94700da109ce97f49ea7635e6ee15
-  data.tar.gz: 9a9efda48ba1e7a566386905c216e1d4edc1d54b850331aeeaed6483045b2202cd6c21ee81d01fea59f74bee2a2b50883096091d809acdb32f7b8d050b80f82a
+  metadata.gz: fa5c2bb43f7807f07d474f596ac57744cd1ae290a688378b4cee60c3604c52a459dad74c2cd46ec7a014b9fdda521723f1f943094d6df1e1d9959ea503089336
+  data.tar.gz: 86314f9c58db0247a5d1621b8d7220546403de38121029209ea158e37a0c805a5355f1f2b80dbb3adef5749916d25c963181b824d2a58d7c80611df1d6925629

data/README.md

@@ -38,12 +38,12 @@ $ sudo gem install bundler
 $ sudo gem install fusuma-plugin-sendkey
 ```
 
-## List available 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.
+To look up a specific key, such as the next or previous song, you can use the `grep -i` filter.
 
 ```sh
 $ fusuma-sendkey -l | grep -i song
@@ -51,38 +51,50 @@ NEXTSONG
 PREVIOUSSONG
 ```
 
-## Run fusuma-sendkey on Terminal
+## Running fusuma-sendkey on Terminal
 
-* `fusuma-sendkey` command is available on your terminal
+* `fusuma-sendkey` command is available on your terminal for testing.
 * `fusuma-sendkey` supports modifier keys and multiple key presses.
-Combine keys for pressing the same time with `+` 
+   - Combine keys for pressing the same time with `+` 
+   - Separate keys for pressing sequentially with `,`
 
+### Example (Sendkey with Modifier Keys)
 
 ```sh
-$ fusuma-sendkey LEFTCTRL+T # press ctrl key + t key
+$ fusuma-sendkey LEFTCTRL+T # Open a new tab
+```
+
+### Example (Sendkey with Multiple Key Presses)
+
+```sh
+$ fusuma-sendkey ["LEFTSHIFT+F10", "T", "ENTER", "ESC"] # Google Translate
 ```
 
 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.
+So test them first with `fusuma-sendkey <KEYCODE>` before adding them to config.yml.
 
 
-## Add sendkey properties to config.yml
+## Add Sendkey Properties to config.yml
 
-Add `sendkey:` property in `~/.config/fusuma/config.yml`.
+Add the `sendkey:` property in your `~/.config/fusuma/config.yml`.
 
-lines beginning from `#` are comments
+Lines beginning with `#` are comments.
 
 ```yaml
 swipe:
   3:
     left:
-      sendkey: "LEFTALT+RIGHT" # history back
+      sendkey: "LEFTALT+RIGHT" # History back
     right:
-      sendkey: "LEFTALT+LEFT" # history forward
+      sendkey: "LEFTALT+LEFT" # History forward
     up:
-      sendkey: "LEFTCTRL+T" # open new tab
+      sendkey: "LEFTCTRL+T" # Open a new tab
     down:
-      sendkey: "LEFTCTRL+W" # close tab
+      sendkey: "LEFTCTRL+W" # Close a tab
+
+hold:
+  3:
+    sendkey: ["LEFTSHIFT+F10", "T", "ENTER", "ESC"] # Translate in Google Chrome
 ```
 
 ### clearmodifiers
@@ -96,21 +108,19 @@ swipe:
       keypress:
         LEFTSHIFT:
           sendkey: "LEFTMETA+DOWN"
-          clearmodifiers: true # clear LEFTSHIFT before sending LEFTMETA+DOWN
+          clearmodifiers: true # Clear LEFTSHIFT before sending LEFTMETA+DOWN
 ```
 
+### Specify Keyboard by Device Name
 
-### 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
+If you encounter the following error message, please set your keyboard name in `plugin.executors.sendkey_executor.device_name` in config.yml.
 
-```shell
+```sh
 $ 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.
+Add the following code to the bottom of `~/.config/fusuma/config.yml` to recognize only the specified keyboard device.
 
 ```yaml
 plugin:
@@ -119,8 +129,7 @@ plugin:
       device_name: 'YOUR KEYBOARD NAME'
 ```
 
-**If [fusuma-plugin-remap](https://github.com/iberianpig/fusuma-plugin-remap) is available, it will be automatically connected to `fusuma_virtual_keyboard`, so `device_name` option is not required.**
-
+**Note**: If [fusuma-plugin-remap](https://github.com/iberianpig/fusuma-plugin-remap) is available, it will automatically connect to `fusuma_virtual_keyboard`, so the `device_name` option is not required.
 
 ## Contributing
 

data/exe/fusuma-sendkey

@@ -36,13 +36,25 @@ if option[:version]
   return
 end
 
-param = ARGV.first
+args = ARGV.first
 
-if param.nil?
+if args.nil?
   warn 'fusuma-sendkey require 1 arugument'
   warn 'e.g. fusuma-sendkey LEFTALT+LEFT'
+  warn 'e.g. fusuma-sendkey [A, B, C]'
   exit 1
 end
 
+
+# remove [ and ] from args
+params = args.delete('[]').split(',').map(&:strip)
+require 'debug'; debugger
+
 keyboard = Fusuma::Plugin::Sendkey::Keyboard.new(name_pattern: device_name)
-keyboard.valid?(param: param) && keyboard.type(param: param)
+return unless keyboard.valid?(params)
+
+if params.size == 1
+  keyboard.type(param: params.first)
+else
+  keyboard.types(params)
+end

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

@@ -26,12 +26,21 @@ module Fusuma
         # @param event [Event]
         # @return [nil]
         def execute(event)
-          MultiLogger.info(sendkey: search_param(event))
-          keyboard.type(
-            param: search_param(event),
-            keep: search_keypress(event),
-            clear: clearmodifiers(event)
-          )
+          params = search_param(event)
+          MultiLogger.info(sendkey: params)
+          case params
+          when Array
+            keyboard.types(params)
+          when String
+            keyboard.type(
+              param: params,
+              keep: search_keypress(event),
+              clear: clearmodifiers(event)
+            )
+          else
+            MultiLogger.error("sendkey: Invalid config: #{params}")
+            nil
+          end
         end
 
         # check executable
@@ -40,7 +49,7 @@ module Fusuma
         def executable?(event)
           event.tag.end_with?("_detector") &&
             event.record.type == :index &&
-            keyboard.valid?(param: search_param(event))
+            keyboard.valid?(search_param(event))
         end
 
         private

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

@@ -3,7 +3,7 @@
 require "revdev"
 require "fusuma/device"
 
-require_relative "./device"
+require_relative "device"
 
 module Fusuma
   module Plugin
@@ -27,7 +27,7 @@ module Fusuma
         def self.find_device(name_pattern:)
           Fusuma::Device.reset
           Fusuma::Device.all.find { |d|
-            next unless d.capabilities.include? "keyboard"
+            next unless /keyboard/.match?(d.capabilities)
 
             d.name.match(/#{name_pattern}/)
           }
@@ -45,9 +45,23 @@ module Fusuma
           @device = Device.new(path: "/dev/input/#{device.id}")
         end
 
+        # @param params [Array]
+        def types(args)
+          return unless args.is_a?(Array)
+
+          args.each do |arg|
+            case arg
+            when String
+              type(param: arg)
+            when Hash
+              type(**arg)
+            end
+          end
+        end
+
         # @param param [String] key names separated by '+' to type
         # @param keep [String] key names separated by '+' to keep
-        # @param clear [String, Symbol, TrueClass] key names separated by '+' to clear or :all to relase all modifiers
+        # @param clear [String, Symbol, TrueClass] key names separated by '+' to clear or :all to release all modifiers
         def type(param:, keep: "", clear: :none)
           return unless param.is_a?(String)
 
@@ -80,11 +94,18 @@ module Fusuma
         end
 
         # @param param [String]
-        def valid?(param:)
-          return unless param.is_a?(String)
-
-          keycodes = param_to_keycodes(param)
-          keycodes.all? { |keycode| support?(keycode) }
+        def valid?(params)
+          case params
+          when Array
+            params.all? { |param| valid?(param) }
+          when String
+            param = params
+            keycodes = param_to_keycodes(param)
+            keycodes.all? { |keycode| support?(keycode) }
+          else
+            MultiLogger.error "sendkey: Invalid config: #{params}"
+            nil
+          end
         end
 
         def send_event(code:, press: true)

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

@@ -3,7 +3,7 @@
 module Fusuma
   module Plugin
     module Sendkey
-      VERSION = "0.10.1"
+      VERSION = "0.11.0"
     end
   end
 end

data/lib/fusuma/plugin/sendkey.rb

@@ -2,5 +2,5 @@
 
 # fusuma will `require fusuma-plugin-xxxx/plugin/xxxx.rb`
 
-require_relative "./sendkey/version"
-require_relative "./executors/sendkey_executor"
+require_relative "sendkey/version"
+require_relative "executors/sendkey_executor"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma-plugin-sendkey
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - iberianpig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-03 00:00:00.000000000 Z
+date: 2024-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fusuma
@@ -77,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Fusuma plugin to send keyboard events