fusuma-plugin-keypress 0.1.1 → 0.4.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba7624b5d5749ace3e2c6238292d7b6ef2ab0f5a65735e50b1aab2147c3e0370
-  data.tar.gz: 297e7e5651be6a4ad278ed9aaac8523f09438a4e2c112d1e19ca8298ab459880
+  metadata.gz: 6e19797193a2845f13a7d0dc0bc5715cc0e71b4b31145624cbf1c105b6b6f835
+  data.tar.gz: 688e9f8d56606d1bcdbf687d21ec7c92258d9787a1ca739e435ec2846963d5d2
 SHA512:
-  metadata.gz: 2a05884669bd2c4ccf652f24eefc816eceb530b99f5c588471fc885932c2d5ebb8b4634b6b7cc18a4f643fde839f4086d4192b1766d0eb7dfcddd94258f2ac60
-  data.tar.gz: 8c15dde07405db86a17aa8adc7412b5450b617f4970487d1ecdbfb742d50b3ffd67d287d2a650632fa7f5ee425e4c82aad4f3a1aa45267b149f67bce8f67c31c
+  metadata.gz: a8775fac9db8bc5bf876826014b914cfb5e22b35e4d9a8a190aeb596b21beb8093e4e8c0c44b8fa6269eaffcfbe8275f24071bfc09282f3e451eb9ed8131d5c0
+  data.tar.gz: 8fd0a06993e60e0e215862d945e5ed4633a325b38956c9fcdc830e5d320112b19a443527b75b903a5565650e708b9c6777def3cd42fb027be474ee91e3bb2e2e

data/.gitignore

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

data/.rubocop.yml

@@ -1,3 +1,7 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  NewCops: enable
+
 Metrics/ModuleLength:
   Exclude:
     - "**/*_spec.rb"

data/CHANGELOG.md

@@ -1,5 +1,37 @@
-# Change Log
+# Changelog
 
+## [v0.4.0.pre](https://github.com/iberianpig/fusuma-plugin-keypress/tree/v0.4.0.pre) (2020-11-09)
 
+[Full Changelog](https://github.com/iberianpig/fusuma-plugin-keypress/compare/v0.3.0...v0.4.0.pre)
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+## [v0.3.0](https://github.com/iberianpig/fusuma-plugin-keypress/tree/v0.3.0) (2020-11-09)
+
+[Full Changelog](https://github.com/iberianpig/fusuma-plugin-keypress/compare/v0.2.1...v0.3.0)
+
+## [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.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:**
+
+- 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/Gemfile

@@ -4,3 +4,15 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in fusuma-plugin-keypress.gemspec
 gemspec
+
+gem 'bundler'
+gem 'github_changelog_generator'
+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

@@ -1,7 +1,7 @@
 # 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)
+Keyboard + Touchpad combination plugin for [Fusuma](https://github.com/iberianpig/fusuma)
 
 * Customize gestures with modifier keys
 * Supports multiple modifier key combinations
@@ -10,38 +10,33 @@ Keypress combination plugin for [Fusuma](https://github.com/iberianpig/fusuma)
 
 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.
+This plugin requires [Fusuma](https://github.com/iberianpig/fusuma#update) version 1.4 or later.
 
 ```sh
-$ gem install fusuma-plugin-keypress
+$ sudo gem install fusuma-plugin-keypress
 ```
 
-### Add show-keycode option
+### Add show-keycodes option
 
 Open `~/.config/fusuma/config.yml` and add the following code at the bottom.
 
 ```yaml
-plugin: 
+plugin:
   inputs:
     libinput_command_input:
-      show-keycode: true
+      show-keycodes: true
 ```
 
-**NOTE: fusuma can read your keyboard inputs if show-keycode option is true** 
+**NOTE: fusuma can read your keyboard inputs if show-keycodes option is true**
 
 ## Properties
 
 Add `keypress:` property in `~/.config/fusuma/config.yml`.
 
 Keys following are available for `keypress`.
+
 * `CAPSLOCK`
 * `LEFTALT`
 * `LEFTCTRL`
@@ -50,6 +45,7 @@ Keys following are available for `keypress`.
 * `RIGHTALT`
 * `RIGHTCTRL`
 * `RIGHTSHIFT`
+* `RIGHTMETA`
 
 ## Example
 
@@ -74,15 +70,15 @@ swipe:
         LEFTMETA+LEFTALT:
           command: 'xdotool key --clearmodifiers XF86AudioLowerVolume'
 
-plugin: 
+plugin:
   inputs:
     libinput_command_input:
-      show-keycode: true
+      show-keycodes: true
 ```
 
 * 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 `+` 
+  - If you want to combine a gesture with two keys, combine modifier keys with `+`
 
 ## Contributing
 

data/fusuma-plugin-keypress.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.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.4'
-
-  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'
+  spec.required_ruby_version = '>= 2.4' # https://packages.ubuntu.com/search?keywords=ruby&searchon=names&exact=1&suite=all&section=main
+  spec.add_dependency 'fusuma', '~> 2.0.0.pre2'
 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/buffers/keypress_buffer.rb

@@ -12,7 +12,15 @@ module Fusuma
           return if event&.tag != source
 
           @events.push(event)
-          @events.clear if released?
+        end
+
+        def clear_expired(*)
+          return if @events.empty?
+
+          return unless released?
+
+          released_code = @events.last.record.code
+          @events.delete_if { |e| e.record.code == released_code }
         end
 
         def empty?

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

@@ -5,8 +5,14 @@ module Fusuma
     module Detectors
       # Detect KeypressEvent from KeypressBuffer
       class KeypressDetector < Detector
+        SOURCES = ['keypress'].freeze
         BUFFER_TYPE = 'keypress'
 
+        # Always watch buffers and detect them.
+        def watch?
+          true
+        end
+
         # @param buffers [Array<Event>]
         # @return [Event] if event is detected
         # @return [NilClass] if event is NOT detected
@@ -15,14 +21,13 @@ module Fusuma
 
           return if buffer.empty?
 
-          records = buffer.events.map(&:record)
-
-          index = create_index(records: records)
+          records = buffer.events.select { |e| e.record.status == 'pressed' }.map(&:record)
 
           index_record = Events::Records::IndexRecord.new(
-            index: index,
+            index: create_index(records: records),
             position: :surfix
           )
+
           create_event(record: index_record)
         end
 

data/lib/fusuma/plugin/keypress.rb

@@ -3,8 +3,8 @@
 # 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'
+require_relative './events/records/keypress_record'
+require_relative './filters/keypress_filter'
+require_relative './parsers/keypress_parser'
+require_relative './buffers/keypress_buffer'
+require_relative './detectors/keypress_detector'

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

@@ -3,7 +3,7 @@
 module Fusuma
   module Plugin
     module Keypress
-      VERSION = '0.1.1'
+      VERSION = '0.4.0.pre2'
     end
   end
 end

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

@@ -7,6 +7,18 @@ module Fusuma
       class KeypressParser < Parser
         DEFAULT_SOURCE = 'libinput_command_input'
 
+        AVAILABLE_KEYS = %w[
+          CAPSLOCK
+          LEFTALT
+          LEFTCTRL
+          LEFTMETA
+          LEFTSHIFT
+          RIGHTALT
+          RIGHTCTRL
+          RIGHTSHIFT
+          RIGHTMETA
+        ].freeze
+
         # @param record [String]
         # @return [Records::Gesture, nil]
         def parse_record(record)
@@ -27,6 +39,8 @@ module Fusuma
             code = matched[2]   # LEFTSHIFT
             status = matched[3] # pressed
 
+            return unless AVAILABLE_KEYS.include?(code)
+
             Events::Records::KeypressRecord.new(status: status, code: code)
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma-plugin-keypress
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0.pre2
 platform: ruby
 authors:
 - iberianpig
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-02-18 00:00:00.000000000 Z
+date: 2021-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fusuma
@@ -16,154 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 2.0.0.pre2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
-- !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'
+        version: 2.0.0.pre2
 description: fusuma-plugin-keypress is Fusuma plugin for keypress combination.
 email:
 - yhkyky@gmail.com
@@ -183,6 +43,7 @@ files:
 - bin/console
 - bin/setup
 - fusuma-plugin-keypress.gemspec
+- lefthook.yml
 - lib/fusuma/plugin/buffers/keypress_buffer.rb
 - lib/fusuma/plugin/detectors/keypress_detector.rb
 - lib/fusuma/plugin/events/records/keypress_record.rb
@@ -194,7 +55,7 @@ homepage: https://github.com/iberianpig/fusuma-plugin-keypress
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -202,15 +63,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Keypress plugin for Fusuma
 test_files: []