fusuma-plugin-sendkey 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: afdee578801f2000ddbdccc13fb96f038690a562f6e391202867f02aa5f7c01b
+  data.tar.gz: 61443a67eaaa58354c8843a4133c30d6063e148bc98ff2d683a49782615ddbd1
+SHA512:
+  metadata.gz: 05adaa93109610fc54290512fd9d1694c99eb2db192f1976254d26d6d9d65b1691e576b5eb001aa61a72a564f5bbfa084d542e1c43f3209df4d99cc954e2d2d5
+  data.tar.gz: fc7358d9338e3ea77d868c219db41277857983fe85fcbc5c8d1801d1fd94563277d2b10a1686f7aeed96f5ab627172b6ef00f7ce6883d2cd9b16d234b784b137

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+Metrics/ModuleLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"
+    - "fusuma-plugin-*.gemspec"
+
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+    - "fusuma-plugin-*.gemspec"

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: 
+ - gem install bundler -v 2.0.1
+ - sudo apt-get -y install evemu-tools libevdev-dev

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at yhkyky@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fusuma-plugin-sendkey.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 iberianpig
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# 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
+
+* Send emulate keyboard events with evemu-event
+* This plugin replaces xdotool
+
+## Installation
+
+Run the following code in your terminal.
+
+### Install dependencies
+
+```sh
+$ sudo apt-get install evemu-tools libevdev-dev
+```
+
+### Install fusuma-plugin-sendkey
+
+```sh
+$ gem install fusuma-plugin-sendkey
+```
+
+
+## List avaiable keys
+
+```sh
+$ fusuma-sendkey -l
+```
+
+## Run fusuma-sendkey on Terminal
+
+* `fusuma-sendkey` can emulate keyboard inputs as a command
+* Combine keys for pressing the same time with `+` 
+
+
+```sh
+$ fusuma-sendkey LEFTCTRL+T
+```
+
+
+## Add sendkey properties to config.yml
+
+Add `sendkey:` property in `~/.config/fusuma/config.yml`.
+
+lines beginning from `#` are comments
+
+```yaml
+swipe:
+  3:
+    left:
+      sendkey: "LEFTALT+RIGHT" # history back
+    right:
+      sendkey: "LEFTALT+LEFT" # history forward
+    up:
+      sendkey: "LEFTCTRL+T" # open new tab
+    down:
+      sendkey: "LEFTCTRL+W" # close tab
+```
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Fusuma::Plugin::Sendkey project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/iberianpig/fusuma-plugin-sendkey/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+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__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/fusuma-sendkey

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require_relative '../lib/fusuma/plugin/sendkey/keyboard.rb'
+
+option = {}
+opt = OptionParser.new
+
+opt.on('-l', '--list-keycodes',
+       'List available keycodes') do |v|
+  option[:list] = v
+end
+
+opt.on('--version', 'Show version') do |v|
+  option[:version] = v
+end
+
+opt.parse!(ARGV)
+
+if option[:list]
+  puts Keyboard.new.available_codes
+  return
+end
+
+if option[:version]
+  puts Fusuma::Plugin::Sendkey::VERSION
+  return
+end
+
+param = ARGV.first
+
+if param.nil?
+  warn 'fusuma-sendkey require 1 arugument'
+  warn 'e.g. fusuma-sendkey LEFTALT+LEFT'
+  exit 1
+end
+
+Keyboard.new.type_command(param: param).tap do |command|
+  exec(command)
+end

data/fusuma-plugin-sendkey.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fusuma/plugin/sendkey/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fusuma-plugin-sendkey'
+  spec.version       = Fusuma::Plugin::Sendkey::VERSION
+  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.homepage      = 'https://github.com/iberianpig/fusuma-plugin-sendkey'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  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_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/lib/fusuma/plugin/executors/sendkey_executor.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative '../sendkey/keyboard.rb'
+
+module Fusuma
+  module Plugin
+    module Executors
+      # Control Window or Workspaces by executing wctrl
+      class SendkeyExecutor < Executor
+        # execute sendkey command
+        # @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))
+          end
+
+          Process.detach(pid)
+        end
+
+        # check executable
+        # @param event [Event]
+        # @return [TrueClass, FalseClass]
+        def executable?(event)
+          event.tag.end_with?('_detector') &&
+            event.record.type == :index &&
+            search_command(event)
+        end
+
+        # @param event [Event]
+        # @return [String]
+        # @return [NilClass]
+        def search_command(event)
+          @keyboard ||= Keyboard.new
+          @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)
+        end
+      end
+    end
+  end
+end

data/lib/fusuma/plugin/sendkey.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# fusuma will `require fusuma-plugin-xxxx/plugin/xxxx.rb`
+
+require_relative './sendkey/version'
+require_relative './executors/sendkey_executor'

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

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'evdev'
+
+# Emulate Keyboard
+class Keyboard
+  def initialize
+    @device = Device.new
+    @path = @device.path
+  end
+
+  # @param param [String]
+  def type_command(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) }
+
+    (press_commands | release_commands).join(' && ')
+  end
+
+  def press_command(code)
+    return unless support?(code)
+
+    @device.emulate(code: code, press: true)
+  end
+
+  def release_command(code)
+    return unless support?(code)
+
+    @device.emulate(code: code, press: false)
+  end
+
+  def support?(code)
+    @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
+  end
+
+  def available_codes
+    @device.search_codes
+  end
+
+  # handle Evdev device
+  class Device
+    attr_reader :device_id
+    def initialize
+      (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
+          false
+        end
+      end
+    end
+
+    def path
+      raise 'Keyboard 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}"
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Fusuma
+  module Plugin
+    module Sendkey
+      VERSION = '0.1.0'
+    end
+  end
+end

metadata

@@ -0,0 +1,229 @@
+--- !ruby/object:Gem::Specification
+name: fusuma-plugin-sendkey
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- iberianpig
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: evdev
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fusuma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.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 evemu-event
+email:
+- yhkyky@gmail.com
+executables:
+- fusuma-sendkey
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/fusuma-sendkey
+- fusuma-plugin-sendkey.gemspec
+- lib/fusuma/plugin/executors/sendkey_executor.rb
+- lib/fusuma/plugin/sendkey.rb
+- lib/fusuma/plugin/sendkey/keyboard.rb
+- lib/fusuma/plugin/sendkey/version.rb
+homepage: https://github.com/iberianpig/fusuma-plugin-sendkey
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Fusuma plugin that sending virtual keyboard events
+test_files: []