fusuma 1.10.0 → 2.0.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 655c4a7bf0a13e28b0334d0edbc59ec29ff69b925f4495ac7f554fd1f995503f
-  data.tar.gz: a4678c0c54de5adf34606c82f46ebb7cc0339df7e0f7fb5fbcbb2042cc6a8e6e
+  metadata.gz: 6f7ab066b275d3d5bdf59d18a948d297d0e164f71d0611e6f999c71d962a8f6d
+  data.tar.gz: f92ff70084e6b98482236b67b2f2c68d7424f7cb8ff1e9ad6b61f4a7d4bea244
 SHA512:
-  metadata.gz: 69a35cbdcecd922e11b590851c3b10b42a84af66ccc8d7c02f5dba9a240747cde283bd069a778b7e503be6b0558927df3897283e7730ac3ac003c185de1a5f51
-  data.tar.gz: 0c68f21dd7647dc846e44a71bb2cff71a46bebb2551448cf0e759727e7381258efd43ca26eb00a7580410d2d9093c03a42a3af3ccea62332167468235083de8d
+  metadata.gz: 885b781c3ec389cc6e37a68eb0799044e8792587145875d7c3facb59dc3a003cd53c4beb9d2a539f534f4947b2a5cf4d43442a9d3a0dba929744881feac7607c
+  data.tar.gz: a79c1f4390694af343cb98901f30916c32642ff5318181a8191c855997eff64aea3dc4a88f02b51a7bfb2565ac7037965bb2816b24141eab6bcd6a23f9ce04dc

data/.github/pull_request_template.md

@@ -0,0 +1,9 @@
+Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
+
+- [ ] Make sure to open an issue as a [bug/issue](https://github.com/iberianpig/fusuma/issues) before writing your code!  That way we can discuss the change, evaluate designs, and agree on the general idea.
+
+- [ ] Follow the instructions in [CONTRIBUTING](https://github.com/iberianpig/fusuma/blob/master/CONTRIBUTING.md). Most importantly, ensure the tests and linter pass by running `bundle exec rspec` and `bundle exec rubocop`.
+
+- [ ] Update code documentation if necessary.
+
+closes: #<issue_number_goes_here>

data/.rubocop.yml

@@ -1,5 +1,9 @@
 inherit_from: .rubocop_todo.yml
 
+AllCops:
+  TargetRubyVersion: '2.5'
+  NewCops: enable
+
 Metrics/ModuleLength:
   Exclude:
     - "**/*_spec.rb"
@@ -14,3 +18,26 @@ Layout/LineLength:
   Exclude:
     - "fusuma.gemspec"
     - "**/*_spec.rb"
+
+# For rubocop < 1.0.0
+Style/HashEachMethods:
+  Enabled: true
+
+# For rubocop < 1.0.0
+Style/HashTransformKeys:
+  Enabled: true
+
+# For rubocop < 1.0.0
+Style/HashTransformValues:
+  Enabled: true
+
+Lint/RaiseException:
+   Enabled: true
+Lint/StructNewOverride:
+   Enabled: true
+
+# for declaring dummy classes in ./spec
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - "**/*_spec.rb"
+

data/.rubocop_todo.yml

@@ -1,24 +1,49 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-01-07 13:21:56 +0900 using RuboCop version 0.78.0.
+# on 2021-03-28 13:34:27 UTC using RuboCop version 1.10.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 5
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 104
+
+# Offense count: 9
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 25
+  Max: 67
 
-# Offense count: 1
-# Configuration parameters: CountComments.
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 101
+  Max: 121
 
-# Offense count: 8
-# Configuration parameters: CountComments, ExcludedMethods.
+# Offense count: 7
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 12
+
+# Offense count: 24
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 15
+  Max: 57
+
+# Offense count: 5
+# Configuration parameters: IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 13
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyleForLeadingUnderscores.
+# SupportedStylesForLeadingUnderscores: disallowed, required, optional
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'lib/fusuma/plugin/detectors/detector.rb'
 
 # Offense count: 3
 Style/Documentation:
@@ -28,13 +53,3 @@ Style/Documentation:
     - 'lib/fusuma/plugin/detectors/pinch_detector.rb'
     - 'lib/fusuma/plugin/detectors/rotate_detector.rb'
     - 'lib/fusuma/plugin/detectors/swipe_detector.rb'
-
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, EnforcedStyle, IgnoredMethods.
-# SupportedStyles: predicate, comparison
-Style/NumericPredicate:
-  Exclude:
-    - 'spec/**/*'
-    - 'lib/fusuma/plugin/detectors/rotate_detector.rb'
-    - 'lib/fusuma/plugin/detectors/swipe_detector.rb'

data/.solargraph.yml

@@ -0,0 +1,16 @@
+---
+include:
+- "**/*.rb"
+exclude:
+- spec/**/*
+- test/**/*
+- vendor/**/*
+- ".bundle/**/*"
+require: []
+domains: []
+reporters:
+- rubocop
+# - require_not_found
+require_paths: []
+plugins: []
+max_files: 5000

data/.travis.yml

@@ -3,9 +3,7 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.3.1
-  - 2.4
-  - 2.5
+  - 2.5.1
   - 2.6
   - 2.7
 before_install: gem install bundler --no-document -v 2.0.1

data/CHANGELOG.md

@@ -1,5 +1,57 @@
 # Changelog
 
+## [v1.11.0](https://github.com/iberianpig/fusuma/tree/v1.11.0) (2020-07-25)
+
+[Full Changelog](https://github.com/iberianpig/fusuma/compare/v1.10.2...v1.11.0)
+
+**Implemented enhancements:**
+
+- Feature/yaml check [\#193](https://github.com/iberianpig/fusuma/pull/193) ([iberianpig](https://github.com/iberianpig))
+
+## [v1.10.2](https://github.com/iberianpig/fusuma/tree/v1.10.2) (2020-07-23)
+
+[Full Changelog](https://github.com/iberianpig/fusuma/compare/v1.10.1...v1.10.2)
+
+**Closed issues:**
+
+- Gestures from libinput are not recognised [\#192](https://github.com/iberianpig/fusuma/issues/192)
+- Vertical 4 finger swipe and rotation not recognised [\#189](https://github.com/iberianpig/fusuma/issues/189)
+- Pinch in gesture not recognized in Popos 20.04 \(Ubuntu 20.04\) [\#184](https://github.com/iberianpig/fusuma/issues/184)
+- Fusuma crashes while switching between workspaces on KDE Plasma [\#181](https://github.com/iberianpig/fusuma/issues/181)
+- Window Prev/Next moves desktop environment when no active window [\#178](https://github.com/iberianpig/fusuma/issues/178)
+- Add ydotool to docs. [\#177](https://github.com/iberianpig/fusuma/issues/177)
+- Can't use alternative .config.yml [\#176](https://github.com/iberianpig/fusuma/issues/176)
+- Fusuma stops working sometimes [\#175](https://github.com/iberianpig/fusuma/issues/175)
+- Pinch \(2, in\) does not work. [\#174](https://github.com/iberianpig/fusuma/issues/174)
+
+**Merged pull requests:**
+
+- 177. Add ydootool to docs. [\#179](https://github.com/iberianpig/fusuma/pull/179) ([mattdemarillac](https://github.com/mattdemarillac))
+
+## [v1.10.1](https://github.com/iberianpig/fusuma/tree/v1.10.1) (2020-05-15)
+
+[Full Changelog](https://github.com/iberianpig/fusuma/compare/v1.10.0...v1.10.1)
+
+**Closed issues:**
+
+- Some gestures are not always recognized [\#172](https://github.com/iberianpig/fusuma/issues/172)
+- Unable to reprogram Pinch  [\#171](https://github.com/iberianpig/fusuma/issues/171)
+
+## [v1.10.0](https://github.com/iberianpig/fusuma/tree/v1.10.0) (2020-05-04)
+
+[Full Changelog](https://github.com/iberianpig/fusuma/compare/v1.9.0...v1.10.0)
+
+**Closed issues:**
+
+- Each action took about 2 secs to react [\#167](https://github.com/iberianpig/fusuma/issues/167)
+- ruby2.7 [\#164](https://github.com/iberianpig/fusuma/issues/164)
+- Zoom-in not really usable on Vivaldi [\#159](https://github.com/iberianpig/fusuma/issues/159)
+- Reversed directions with no alternatives [\#133](https://github.com/iberianpig/fusuma/issues/133)
+
+**Merged pull requests:**
+
+- Implement timeout event  [\#169](https://github.com/iberianpig/fusuma/pull/169) ([iberianpig](https://github.com/iberianpig))
+
 ## [v1.9.0](https://github.com/iberianpig/fusuma/tree/v1.9.0) (2020-03-30)
 
 [Full Changelog](https://github.com/iberianpig/fusuma/compare/v1.8.0...v1.9.0)
@@ -159,8 +211,7 @@
 **Merged pull requests:**
 
 - Interval and threshold specific for a trigger [\#92](https://github.com/iberianpig/fusuma/pull/92) ([irq](https://github.com/irq))
-- Assigning commands [\#73](https://github.com/iberianpig/fusuma/pull/73) ([iberianpig](https://github.com/iberianpig))
-- Relax the device name regex [\#9](https://github.com/iberianpig/fusuma/pull/9) ([z0rc](https://github.com/z0rc))
+- Fix spelling: Elementary to elementary [\#90](https://github.com/iberianpig/fusuma/pull/90) ([ryonakano](https://github.com/ryonakano))
 
 ## [v0.9.2](https://github.com/iberianpig/fusuma/tree/v0.9.2) (2018-07-19)
 
@@ -196,7 +247,7 @@
 
 **Closed issues:**
 
-- Print system information for debuging [\#70](https://github.com/iberianpig/fusuma/issues/70)
+- Print system information for debugging [\#70](https://github.com/iberianpig/fusuma/issues/70)
 - rescue from SIGINT Interruption with Ctrl-C [\#64](https://github.com/iberianpig/fusuma/issues/64)
 
 ## [v0.7.1](https://github.com/iberianpig/fusuma/tree/v0.7.1) (2018-06-01)
@@ -249,6 +300,7 @@
 
 **Merged pull requests:**
 
+- Assigning commands [\#73](https://github.com/iberianpig/fusuma/pull/73) ([iberianpig](https://github.com/iberianpig))
 - Update rake requirement to ~\> 12.3 [\#72](https://github.com/iberianpig/fusuma/pull/72) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
 
 ## [v0.3.5](https://github.com/iberianpig/fusuma/tree/v0.3.5) (2018-01-01)
@@ -294,7 +346,6 @@
 
 **Merged pull requests:**
 
-- Fix spelling: Elementary to elementary [\#90](https://github.com/iberianpig/fusuma/pull/90) ([ryonakano](https://github.com/ryonakano))
 - Added interval options to config. [\#36](https://github.com/iberianpig/fusuma/pull/36) ([joshuatshaffer](https://github.com/joshuatshaffer))
 
 ## [v0.2.7](https://github.com/iberianpig/fusuma/tree/v0.2.7) (2017-02-04)
@@ -382,6 +433,7 @@
 **Merged pull requests:**
 
 - Match left and right actions [\#10](https://github.com/iberianpig/fusuma/pull/10) ([z0rc](https://github.com/z0rc))
+- Relax the device name regex [\#9](https://github.com/iberianpig/fusuma/pull/9) ([z0rc](https://github.com/z0rc))
 
 ## [v0.1.3](https://github.com/iberianpig/fusuma/tree/v0.1.3) (2016-11-01)
 

data/CONTRIBUTING.md

@@ -0,0 +1,72 @@
+# Contributing to Fusuma
+
+1. Fork the repo, develop and test your code changes.
+2. Send a pull request.
+
+## Setup
+
+In order to use the Fusuma console and run the project's tests,
+there is a small amount of setup:
+
+1. Install Ruby. Fusuma requires Ruby 2.3+. You may choose to
+   manage your Ruby and gem installations with [RVM](https://rvm.io/),
+   [rbenv](https://github.com/rbenv/rbenv), or
+   [chruby](https://github.com/postmodern/chruby).
+
+2. Install [Bundler](http://bundler.io/).
+
+   ```sh
+   $ gem install bundler
+   ```
+
+3. Install the top-level project dependencies.
+
+   ```sh
+   $ bundle install
+   ```
+
+## Fusuma Tests
+
+Tests are very important part of Fusuma. All contributions
+should include tests that ensure the contributed code behaves as expected.
+
+To run tests:
+
+``` sh
+$ bundle exec rspec
+```
+
+### Fusuma Document
+
+The project uses [YARD](https://github.com/lsegal/yard) for generating documentation.  
+
+If you're not sure about YARD, please refer to [YARD cheatsheet](https://gist.github.com/phansch/db18a595d2f5f1ef16646af72fe1fb0e).
+
+To run the Fusuma documentation tests:
+
+``` sh
+$ bundle exec yard --fail-on-warning
+```
+
+To check Fusuma documents with running local server:
+
+```
+$ bundle exec yard server
+```
+Then open (http://localhost:8808/)
+
+## Coding Style
+
+Please follow the established coding style in the library.
+The style is is largely based on [The Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide).
+
+You can check your code against these rules by running Rubocop like so:
+
+```sh
+$ bundle exec rubocop
+```
+
+## Code of Conduct
+
+Please note that this project is released with a Contributor Code of Conduct. By
+participating in this project you agree to abide by its terms.

data/Gemfile

@@ -4,3 +4,20 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in fusuma.gemspec
 gemspec
+
+gem 'bundler'
+gem 'coveralls'
+gem 'github_changelog_generator', '~> 1.14'
+gem 'pry-byebug', '~> 3.4'
+gem 'pry-doc'
+gem 'pry-inline'
+gem 'rake', '~> 13.0'
+gem 'rblineprof'
+gem 'rblineprof-report'
+gem 'reek'
+gem 'rspec', '~> 3.0'
+gem 'rubocop'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'
+gem 'solargraph'
+gem 'yard'

data/README.md

@@ -17,7 +17,7 @@ This gem makes your linux able to recognize swipes or pinchs and assign commands
 
 ## Installation
 
-### 1. Grant permission to read the touchpad device
+### Grant permission to read the touchpad device
 
 **IMPORTANT**: You **MUST** be a member of the **INPUT** group to read touchpad by Fusuma.
 
@@ -25,9 +25,15 @@ This gem makes your linux able to recognize swipes or pinchs and assign commands
 $ sudo gpasswd -a $USER input
 ```
 
-Then, You **MUST** **REBOOT** to assign this group.
+Then, You apply the change with no logout or reboot.
 
-### 2. Install libinput-tools
+```bash
+$ newgrp input
+```
+
+### For Debian Based Distros (Ubuntu, Debian, Mint, Pop!OS)
+
+#### 1. Install libinput-tools
 
 You need `libinput` release 1.0 or later.
 
@@ -35,7 +41,7 @@ You need `libinput` release 1.0 or later.
 $ sudo apt-get install libinput-tools
 ```
 
-### 3. Install Ruby
+#### 2. Install Ruby
 
 Fusuma runs in Ruby, so you must install it first.
 
@@ -43,13 +49,13 @@ Fusuma runs in Ruby, so you must install it first.
 $ sudo apt-get install ruby
 ```
 
-### 4. Install Fusuma
+#### 3. Install Fusuma
 
 ```bash
 $ sudo gem install fusuma
 ```
 
-### 5. Install xdotool (optional)
+#### 4. Install xdotool (optional)
 
 For sending shortcuts:
 
@@ -57,6 +63,42 @@ For sending shortcuts:
 $ sudo apt-get install xdotool
 ```
 
+### For Arch Based Distros (Manjaro, Arch)
+
+#### 1. Install libinput.
+
+You need `libinput` release 1.0 or later. This is most probably installed by default on Manjaro
+
+```z-h
+$ sudo pacman -S libinput
+```
+
+#### 2. Install Ruby
+
+Fusuma runs in Ruby, so you must install it first.
+
+```zsh
+$ sudo pacman -S ruby
+```
+
+#### 3. Install Fusuma
+
+**Note:** 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)
+
+```zsh
+$ sudo gem install fusuma
+```
+
+#### 4. Install xdotool (optional)
+
+For sending shortcuts:
+
+```zsh
+$ sudo pacman -S xdotool
+```
+
 ### Touchpad not working in GNOME
 
 Ensure the touchpad events are being sent to the GNOME desktop by running the following command:
@@ -181,7 +223,6 @@ pinch:
   2: 
     in:
       command: "xdotool keydown ctrl click 4 keyup ctrl" # threshold: 0.5, interval: 0.5
-  2: 
     out:
       command: "xdotool keydown ctrl click 5 keyup ctrl" # threshold: 0.5, interval: 0.5
 
@@ -239,6 +280,11 @@ swipe:
 - `xte`
   - [xte(1) - Linux man page](https://linux.die.net/man/1/xte)
   - install with `sudo apt xautomation`
+  
+- [ydotool](https://github.com/ReimuNotMoe/ydotool)
+  - Wayland compatible
+  - Needs more maintainers.
+  - Requires only replacing `xdotool` with `ydotool` in fusuma conf.
 
 ## Options