fusuma-plugin-keypress 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5ac6defa566a26b20d4df701ed11054d7c18f7a160cd4920ed5507b310c6eadd
+  data.tar.gz: 3b5f4bca453556923f27688886ecbe41b32c0b144474f7ffe4501373b3c9799e
+SHA512:
+  metadata.gz: dd261eb913cad03aa7245b6ef21772b668818e1d654f630f5d118f43591e4edaec698d67f36b595aa0553e36b988e227cf3b97aa8b4299c72d85b0a7f17706d6
+  data.tar.gz: 484c87be4cf79c6af3871691c6f3286034fe8b8d41a8a868673ad2e7cd1f0922cb3f553e4263a291aea1e8672d1d69ccffa2768022e176d90bd53c89b4d33c63

data/.gitignore

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

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/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

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,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fusuma-plugin-keypress.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 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,89 @@
+# Fusuma::Plugin::Keypress [![Gem Version](https://badge.fury.io/rb/fusuma-plugin-keypress.svg)](https://badge.fury.io/rb/fusuma-plugin-keypress) [![Build Status](https://travis-ci.com/iberianpig/fusuma-plugin-keypress.svg?branch=master)](https://travis-ci.com/iberianpig/fusuma-plugin-keypress)
+
+
+Keypress combination plugin for [Fusuma](https://github.com/iberianpig/fusuma)
+
+## Installation
+
+Run the following code in your terminal.
+
+### Install libinput-tools
+
+```sh
+$ sudo apt-get install libinput-tools
+```
+
+### Install fusuma-plugin-keypress
+
+This plugin requires [Fusuma](https://github.com/iberianpig/fusuma#update) version 1.3 or later.
+
+```sh
+$ gem install fusuma-plugin-keypress
+```
+
+### Add show-keycode option
+
+Modify ~/.config/fusuma following
+
+```yaml
+plugin: 
+  inputs:
+    libinput_command_input:
+      show-keycode: true
+```
+
+**NOTE: fusuma can read your keyboard inputs if show-keycode option is true** 
+
+## Properties
+
+Add `keypress:` property in `~/.config/fusuma/config.yml`.
+
+Keys following are available for `keypress`.
+* `CAPSLOCK`
+* `LEFTALT`
+* `LEFTCTRL`
+* `LEFTMETA`
+* `LEFTSHIFT`
+* `RIGHTALT`
+* `RIGHTCTRL`
+* `RIGHTSHIFT`
+
+## Example
+
+Set `keypress:` property and values under gesture in `~/.config/fusuma/config.yml`.
+
+```yaml
+swipe:
+  4:
+    up:
+      command: 'xdotool key super+s'
+      keypress:
+        LEFTMETA:
+          command: 'xdotool key --clearmodifiers XF86MonBrightnessUp'
+        LEFTMETA+LEFTALT:
+          command: 'xdotool key --clearmodifiers XF86AudioRaiseVolume'
+
+    down:
+      command: 'xdotool key super+a'
+      keypress:
+        LEFTMETA:
+          command: 'xdotool key --clearmodifiers XF86MonBrightnessDown'
+        LEFTMETA+LEFTALT:
+          command: 'xdotool key --clearmodifiers XF86AudioLowerVolume'
+```
+
+* Swipe up/down with four fingers while keypress LEFTMETA key to change display brightnes .
+* Swipe up/down with four fingers while keypress LEFTMETA and LEFTALT keys to change audio volume.
+  - If you want to combine a gesture with two keys, combine modifier keys with `+` 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/iberianpig/fusuma-plugin-keypress. 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::Keypress project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/iberianpig/fusuma-plugin-keypress/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(: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

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'fusuma'
+require 'fusuma/plugin/keypress'
+
+# 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

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/fusuma-plugin-keypress.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/keypress/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fusuma-plugin-keypress'
+  spec.version       = Fusuma::Plugin::Keypress::VERSION
+  spec.authors       = ['iberianpig']
+  spec.email         = ['yhkyky@gmail.com']
+
+  spec.summary       = 'Keypress plugin for Fusuma '
+  spec.description   = 'fusuma-plugin-keypress is Fusuma plugin for keypress combination.'
+  spec.homepage      = 'https://github.com/iberianpig/fusuma-plugin-keypress'
+  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.required_ruby_version = '>= 2.3' # https://packages.ubuntu.com/search?keywords=ruby&searchon=names&exact=1&suite=all&section=main
+  spec.add_dependency 'fusuma', '~> 1.3'
+
+  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/buffers/keypress_buffer.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Fusuma
+  module Plugin
+    module Buffers
+      # Buffer events having KeypressRecord
+      class KeypressBuffer < Buffer
+        DEFAULT_SOURCE = 'keypress_parser'
+
+        # @param event [Event]
+        def buffer(event)
+          return if event&.tag != source
+
+          @events.push(event)
+          @events.clear if released?
+        end
+
+        def empty?
+          @events.empty?
+        end
+
+        private
+
+        def released?
+          true if @events.last.record.status =~ /released/
+        end
+      end
+    end
+  end
+end

data/lib/fusuma/plugin/detectors/keypress_detector.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Fusuma
+  module Plugin
+    module Detectors
+      # Detect KeypressEvent from KeypressBuffer
+      class KeypressDetector < Detector
+        BUFFER_TYPE = 'keypress'
+
+        # @param buffers [Array<Buffer>]
+        # @return [Event] if event is detected
+        # @return [NilClass] if event is NOT detected
+        def detect(buffers)
+          buffer = buffers.find { |b| b.type == BUFFER_TYPE }
+
+          return if buffer.empty?
+
+          records = buffer.events.map(&:record)
+
+          index = create_index(records: records)
+
+          index_record = Events::Records::IndexRecord.new(
+            index: index,
+            position: :surfix
+          )
+          create_event(record: index_record)
+        end
+
+        # @param records [Array<Events::Records::KeypressRecord>]
+        # @return [Config::Index]
+        def create_index(records:)
+          code = records.map(&:code).join('+')
+          Config::Index.new(
+            [
+              Config::Index::Key.new('keypress', skippable: true),
+              Config::Index::Key.new(code, skippable: true)
+            ]
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fusuma/plugin/events/records/keypress_record.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Fusuma
+  module Plugin
+    module Events
+      module Records
+        # Record for Keypress event
+        class KeypressRecord < Record
+          attr_reader :status, :code
+
+          # @param status [String]
+          def initialize(status:, code:)
+            @status = status
+            @code = code
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fusuma/plugin/filters/keypress_filter.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Fusuma
+  module Plugin
+    module Filters
+      # Filter keyboard events from libinput_command_input
+      class KeypressFilter < Filter
+        DEFAULT_SOURCE = 'libinput_command_input'
+
+        # @return [TrueClass] when keeping it
+        # @return [FalseClass] when discarding it
+        def keep?(record)
+          record.to_s =~ /\sKEYBOARD_KEY\s/
+        end
+      end
+    end
+  end
+end

data/lib/fusuma/plugin/keypress.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# fusuma will `require fusuma-plugin-xxxx/plugin/xxxx.rb`
+
+require_relative './keypress/version'
+require_relative './events/records/keypress_record.rb'
+require_relative './filters/keypress_filter.rb'
+require_relative './parsers/keypress_parser.rb'
+require_relative './buffers/keypress_buffer.rb'
+require_relative './detectors/keypress_detector.rb'

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

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

data/lib/fusuma/plugin/parsers/keypress_parser.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Fusuma
+  module Plugin
+    module Parsers
+      # Generate KeypressRecord from libinput_command_input
+      class KeypressParser < Parser
+        DEFAULT_SOURCE = 'libinput_command_input'
+
+        # @param record [String]
+        # @return [Records::Gesture, nil]
+        def parse_record(record)
+          line = record.to_s
+
+          # NOTE: example of line
+          # event4   KEYBOARD_KEY      +4.81s      KEY_LEFTSHIFT (42) pressed
+          # event4   KEYBOARD_KEY      +4.90s      KEY_LEFTSHIFT (42) released
+          # event4   KEYBOARD_KEY      +7.39s      KEY_CAPSLOCK (58) pressed
+          # event4   KEYBOARD_KEY      +7.52s      KEY_CAPSLOCK (58) released
+          # event4   KEYBOARD_KEY      +8.98s      KEY_LEFTCTRL (29) pressed
+          # event4   KEYBOARD_KEY      +9.14s      KEY_LEFTCTRL (29) released
+
+          case line
+          when /KEYBOARD_KEY.+(\d+\.\d+)s.*KEY_([A-Z]+).*(pressed|released)/
+            matched = Regexp.last_match
+            # time = matched[1]   # 4.81
+            code = matched[2]   # LEFTSHIFT
+            status = matched[3] # pressed
+
+            Events::Records::KeypressRecord.new(status: status, code: code)
+          end
+        end
+
+        def tag
+          'keypress_parser'
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: fusuma-plugin-keypress
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- iberianpig
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fusuma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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-keypress is Fusuma plugin for keypress combination.
+email:
+- yhkyky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fusuma-plugin-keypress.gemspec
+- lib/fusuma/plugin/buffers/keypress_buffer.rb
+- lib/fusuma/plugin/detectors/keypress_detector.rb
+- lib/fusuma/plugin/events/records/keypress_record.rb
+- lib/fusuma/plugin/filters/keypress_filter.rb
+- lib/fusuma/plugin/keypress.rb
+- lib/fusuma/plugin/keypress/version.rb
+- lib/fusuma/plugin/parsers/keypress_parser.rb
+homepage: https://github.com/iberianpig/fusuma-plugin-keypress
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+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: Keypress plugin for Fusuma
+test_files: []