fusuma 1.10.1 → 1.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9d6954579a300b089bb94a20b3c03b6d2f9729f208af6082b8b5963dd9608e0
-  data.tar.gz: 8a62c074532cdf4e032d1c9c625f1bdf3f42eff7b8f1bdb1ee18ac9168f5c991
+  metadata.gz: dddc8b3508264aaa617b19ed621ed6ee97c5f0d8435cb988a29a9789f9fe2a22
+  data.tar.gz: 8c99bd1dbddf7640d9422ed505ac090361b97b87fc0ea77584ddc6fb8f6416db
 SHA512:
-  metadata.gz: 1d9379023929b19716783509127caaa4f1ffc6951a5951c5a866a0842a6d2f97bf6fbe6e5a83d43a7d0b0bead2fb87324f7a5bfcee8aae60fe1eb7f4265b55d2
-  data.tar.gz: a2aeca01b913ab48f130069de6e2cbce63d4dadabf2cebb7deb81018e584f4993246801cec770a5a1fb87b4d3d83709ad4079c6400edbabd5ce6e38abedef998
+  metadata.gz: 107aa86cb7e326e17e7cb5c183e3fcb49a6352fd1f9b6a04211d2820bd6e738b9abb00f2ecddeef31903f2bb77ad15b7dcc742ca835df9eb9f67e970b166e843
+  data.tar.gz: 294b6a9c9fd0770bf470c38af08f5c48fd7fc14d38f3acd0f802ac3f51e21d200de6d02be1f197edea65c0e5d13ee95f4e43a85c8cea0a0a80372154eda3ea15

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

@@ -14,3 +14,20 @@ 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

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

@@ -181,7 +181,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 +238,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 in fusuma conf.
 
 ## Options
 

data/fusuma.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
 
   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 'coveralls'
   spec.add_development_dependency 'github_changelog_generator', '~> 1.14'
   spec.add_development_dependency 'pry-byebug', '~> 3.4'
   spec.add_development_dependency 'pry-doc'

data/lib/fusuma.rb

@@ -4,6 +4,7 @@ require_relative './fusuma/version'
 require_relative './fusuma/multi_logger'
 require_relative './fusuma/config.rb'
 require_relative './fusuma/environment.rb'
+require_relative './fusuma/device.rb'
 require_relative './fusuma/plugin/manager.rb'
 
 # this is top level module

data/lib/fusuma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fusuma
-  VERSION = '1.10.1'
+  VERSION = '1.10.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: 1.10.2
 platform: ruby
 authors:
 - iberianpig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-15 00:00:00.000000000 Z
+date: 2020-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -177,6 +177,7 @@ files:
 - ".github/FUNDING.yml"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/pull_request_template.md"
 - ".github/stale.yml"
 - ".gitignore"
 - ".reek.yml"
@@ -186,6 +187,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md