fusuma 1.10.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9d6954579a300b089bb94a20b3c03b6d2f9729f208af6082b8b5963dd9608e0
-  data.tar.gz: 8a62c074532cdf4e032d1c9c625f1bdf3f42eff7b8f1bdb1ee18ac9168f5c991
+  metadata.gz: c8b830de9940632862b66b2cd6dbd6cf9ead713a24d7913d31baae7baacef348
+  data.tar.gz: e55c53522a2184c8e6197bc12c4ca203cd844f1277dafbfe02fde48ae8f0d8c6
 SHA512:
-  metadata.gz: 1d9379023929b19716783509127caaa4f1ffc6951a5951c5a866a0842a6d2f97bf6fbe6e5a83d43a7d0b0bead2fb87324f7a5bfcee8aae60fe1eb7f4265b55d2
-  data.tar.gz: a2aeca01b913ab48f130069de6e2cbce63d4dadabf2cebb7deb81018e584f4993246801cec770a5a1fb87b4d3d83709ad4079c6400edbabd5ce6e38abedef998
+  metadata.gz: 8153cf247654a3b70f976f74b0c3d791a962185fec288286f625448e8c23c6b53e134acff8d2ebad51eebdd51fefe8539a8da11c5abbd7744b90f6f943b3316e
+  data.tar.gz: 5065d471bfa721b9e973ac276ffb60db09ed1a5e4f967fa8dd7010856d6709b9c44ea3b9cd5fab82c2b2ae2467a0b072f14a3c779db331abbcda1b9fa479a276

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,42 @@
 # 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)
@@ -210,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)

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
 

data/fusuma.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['iberianpig']
   spec.email         = ['yhkyky@gmail.com']
 
-  spec.summary       = 'Multitouch gestures with libinput dirver on X11, Linux'
+  spec.summary       = 'Multitouch gestures with libinput driver, Linux'
   spec.description   = 'Fusuma is multitouch gesture recognizer. This gem makes your touchpad on Linux able to recognize swipes or pinchs and assign command to them. Read installation on Github(https://github.com/iberianpig/fusuma#installation).'
   spec.homepage      = 'https://github.com/iberianpig/fusuma'
   spec.license       = 'MIT'
@@ -23,16 +23,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.metadata['yard.run'] = 'yri' # use "yard" to build full HTML docs.
 
-  spec.required_ruby_version = '>= 2.3' # https://packages.ubuntu.com/search?keywords=ruby&searchon=names&exact=1&suite=all&section=main
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency "coveralls"
-  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.5.1' # https://packages.ubuntu.com/search?keywords=ruby&searchon=names&exact=1&suite=all&section=main
+  # support bionic (18.04LTS) 2.5.1
+  spec.add_dependency 'posix-spawn'
 end