fusuma 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a67f3ff722cd13d72966f7be8d0292485fcbdc3e72e83914222f762deb4ab37a
-  data.tar.gz: c315fe56fd0d005dd8629ef39cb4405b53bf2e98cba6c1517de750415cf9dd7a
+  metadata.gz: 93c6c3c71411a7eebb99751019f6644162214db4f26905bb5d3b1bd7eb6da917
+  data.tar.gz: ce95d881ac734359d79dba87fc25dfc72a43ef7f4e50ed23b0ca0478883f405c
 SHA512:
-  metadata.gz: a76b5174dd2a568db4b391797fbcb1c3e239a041f69c9399b49969de81b072b3ebf09829182e30829231ca38f52ff84c6966d807b1616eb3ccce6c43e564ad7a
-  data.tar.gz: 811f35941e58962311d9d67448b25d422760f7779678f377c3cbd35b4e89dc197dfb2ee237ac033e654312f1c25261bc8dc1d00fb2d466b3594b4b348fd66b04
+  metadata.gz: 85b9bccb20dd58f97407d7d0955e9fbf378cc1c23f7ccb502f8ae48920faefacbf2dfd2b2fa374de3fbb237d68f0c92207a83e391e0aaab7783853270a98328b
+  data.tar.gz: 2a7cb2e707712d4c4a78e40e641137bb906adf8dbe21d2105cc7c293255f3e5a838f658fc85377a8c12de80f74211443a4bc513cbd4608dc9c611fe9929a9e5e

data/CHANGELOG.md

@@ -1,8 +1,8 @@
 # Changelog
 
-## [Unreleased](https://github.com/iberianpig/fusuma/tree/HEAD)
+## [v1.8.0](https://github.com/iberianpig/fusuma/tree/v1.8.0) (2020-03-28)
 
-[Full Changelog](https://github.com/iberianpig/fusuma/compare/v1.7.0...HEAD)
+[Full Changelog](https://github.com/iberianpig/fusuma/compare/v1.7.0...v1.8.0)
 
 **Implemented enhancements:**
 
@@ -12,6 +12,11 @@
 
 - When xdotool acts crazy. Workaround should be clearly informed. [\#146](https://github.com/iberianpig/fusuma/issues/146)
 
+**Merged pull requests:**
+
+- Fix cops [\#158](https://github.com/iberianpig/fusuma/pull/158) ([iberianpig](https://github.com/iberianpig))
+- Add ruby 2.7 to .travis.yml [\#157](https://github.com/iberianpig/fusuma/pull/157) ([iberianpig](https://github.com/iberianpig))
+
 ## [v1.7.0](https://github.com/iberianpig/fusuma/tree/v1.7.0) (2020-03-25)
 
 [Full Changelog](https://github.com/iberianpig/fusuma/compare/v1.6.0...v1.7.0)
@@ -147,6 +152,7 @@
 
 - Interval and threshold specific for a trigger [\#92](https://github.com/iberianpig/fusuma/pull/92) ([irq](https://github.com/irq))
 - Fix spelling: Elementary to elementary [\#90](https://github.com/iberianpig/fusuma/pull/90) ([ryonakano](https://github.com/ryonakano))
+- Assigning commands [\#73](https://github.com/iberianpig/fusuma/pull/73) ([iberianpig](https://github.com/iberianpig))
 
 ## [v0.9.2](https://github.com/iberianpig/fusuma/tree/v0.9.2) (2018-07-19)
 
@@ -235,7 +241,6 @@
 
 **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)
@@ -279,10 +284,6 @@
 - parse\_finger\_directions: undefined method `tr' for nil:NilClass \(NoMethodError\) [\#29](https://github.com/iberianpig/fusuma/issues/29)
 - Error after upgrading to libinput 1.6.0 [\#26](https://github.com/iberianpig/fusuma/issues/26)
 
-**Merged pull requests:**
-
-- 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)
 
 [Full Changelog](https://github.com/iberianpig/fusuma/compare/v0.2.6...v0.2.7)
@@ -293,6 +294,7 @@
 
 **Merged pull requests:**
 
+- Added interval options to config. [\#36](https://github.com/iberianpig/fusuma/pull/36) ([joshuatshaffer](https://github.com/joshuatshaffer))
 - update parser [\#30](https://github.com/iberianpig/fusuma/pull/30) ([iberianpig](https://github.com/iberianpig))
 
 ## [v0.2.6](https://github.com/iberianpig/fusuma/tree/v0.2.6) (2017-01-22)

data/README.md

@@ -1,4 +1,4 @@
-# Fusuma [![Gem Version](https://badge.fury.io/rb/fusuma.svg)](https://badge.fury.io/rb/fusuma) [![Build Status](https://travis-ci.com/iberianpig/fusuma.svg?branch=master)](https://travis-ci.com/iberianpig/fusuma)
+# Fusuma [![Gem Version](https://badge.fury.io/rb/fusuma.svg)](https://badge.fury.io/rb/fusuma) [![Build Status](https://travis-ci.com/iberianpig/fusuma.svg?branch=master)](https://travis-ci.com/iberianpig/fusuma) [![Coverage Status](https://coveralls.io/repos/github/iberianpig/fusuma/badge.svg?branch=master)](https://coveralls.io/github/iberianpig/fusuma?branch=master) [![Inline docs](http://inch-ci.org/github/iberianpig/fusuma.svg?branch=master)](http://inch-ci.org/github/iberianpig/fusuma)
 
 Fusuma is multitouch gesture recognizer.
 This gem makes your linux able to recognize swipes or pinchs and assign commands to them.
@@ -181,9 +181,21 @@ swipe:
 *   `-d`, `--daemon`              : Daemonize process
 *   `-l`, `--list-devices`        : List available devices
 *   `-v`, `--verbose`             : Show details about the results of running fusuma
-*   `--device="Device name"`      : Open the given device only
+*   `--device="Device name"`      : Open the given device only (DEPRECATED)
 *   `--version`                   : Show fusuma version
 
+### Filter Device
+
+Set the following options to recognize multi-touch gestures only for the specified touchpad device.
+
+```yaml
+plugin:
+  filters:
+    libinput_device_filter:
+      keep_device_names:
+        - "DEVICE NAME"
+```
+
 ## Autostart (gnome-session-properties)
 1. Check the path where you installed fusuma with `$ which fusuma`
 2. Open `$ gnome-session-properties`

data/exe/fusuma

@@ -23,7 +23,7 @@ opt.on('-l', '--list-devices',
 end
 
 opt.on('--device="Device name"',
-       'Open the given device only') do |v|
+       'Open the given device only (DEPRECATED)') do |v|
   option[:device] = v
 end
 

data/fusuma.gemspec

@@ -25,6 +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 'github_changelog_generator', '~> 1.14'
   spec.add_development_dependency 'pry-byebug', '~> 3.4'
   spec.add_development_dependency 'pry-doc'

data/lib/fusuma.rb

@@ -3,8 +3,7 @@
 require_relative './fusuma/version'
 require_relative './fusuma/multi_logger'
 require_relative './fusuma/config.rb'
-require_relative './fusuma/device.rb'
-require_relative './fusuma/libinput_command.rb'
+require_relative './fusuma/environment.rb'
 require_relative './fusuma/plugin/manager.rb'
 
 # this is top level module
@@ -33,38 +32,18 @@ module Fusuma
 
         Plugin::Manager.require_base_plugins
 
-        MultiLogger.info '---------------------------------------------'
-        print_version
-        MultiLogger.info '---------------------------------------------'
-        print_enabled_plugins
-        MultiLogger.info '---------------------------------------------'
+        Environment.dump_information
         Kernel.exit(0) if option[:version]
 
-        print_device_list if option[:list]
+        if option[:list]
+          Environment.print_device_list
+          Kernel.exit(0)
+        end
+
         # TODO: remove keep_device_from_option from command line options
         Plugin::Filters::LibinputDeviceFilter::KeepDevice.from_option = option[:device]
-        Process.daemon if option[:daemon]
-      end
 
-      def print_version
-        MultiLogger.info "Fusuma: #{Fusuma::VERSION}"
-        MultiLogger.info "libinput: #{LibinputCommand.new.version}"
-        MultiLogger.info "OS: #{`uname -rsv`}".strip
-        MultiLogger.info "Distribution: #{`cat /etc/issue`}".strip
-        MultiLogger.info "Desktop session: #{`echo $DESKTOP_SESSION $XDG_SESSION_TYPE`}".strip
-      end
-
-      def print_enabled_plugins
-        MultiLogger.info 'Enabled Plugins: '
-        Plugin::Manager.plugins
-                       .reject { |k, _v| k.to_s =~ /Base/ }
-                       .map { |_base, plugins| plugins.map { |plugin| "  #{plugin}" } }
-                       .flatten.sort.each { |name| MultiLogger.info(name) }
-      end
-
-      def print_device_list
-        puts Device.available.map(&:name)
-        exit(0)
+        Process.daemon if option[:daemon]
       end
 
       def load_custom_config(config_path = nil)
@@ -86,7 +65,7 @@ module Fusuma
     def run
       # TODO: run with multi thread
       @inputs.first.run do |event|
-        clear_expired
+        clear_expired_events
         filtered = filter(event) || next
         parsed = parse(filtered) || next
         buffered = buffer(parsed) || next
@@ -139,7 +118,7 @@ module Fusuma
       executor&.execute(event)
     end
 
-    def clear_expired
+    def clear_expired_events
       @buffers.each(&:clear_expired)
     end
   end

data/lib/fusuma/environment.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative './version.rb'
+require_relative './libinput_command.rb'
+require_relative './multi_logger.rb'
+
+module Fusuma
+  # Output Environment information
+  class Environment
+    class << self
+      def dump_information
+        MultiLogger.info '---------------------------------------------'
+        print_version
+        MultiLogger.info '---------------------------------------------'
+        print_enabled_plugins
+        MultiLogger.info '---------------------------------------------'
+      end
+
+      def print_version
+        MultiLogger.info "Fusuma: #{VERSION}"
+        MultiLogger.info "libinput: #{LibinputCommand.new.version}"
+        MultiLogger.info "OS: #{`uname -rsv`}".strip
+        MultiLogger.info "Distribution: #{`cat /etc/issue`}".strip
+        MultiLogger.info "Desktop session: #{`echo $DESKTOP_SESSION $XDG_SESSION_TYPE`}".strip
+      end
+
+      def print_enabled_plugins
+        MultiLogger.info 'Enabled Plugins: '
+        Plugin::Manager.plugins
+                       .reject { |k, _v| k.to_s =~ /Base/ }
+                       .map { |_base, plugins| plugins.map { |plugin| "  #{plugin}" } }
+                       .flatten.sort.each { |name| MultiLogger.info(name) }
+      end
+
+      def print_device_list
+        Plugin::Filters::LibinputDeviceFilter.new.keep_device.all.map do |device|
+          puts device.name
+        end
+      end
+    end
+  end
+end

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

@@ -36,12 +36,26 @@ module Fusuma
                            end
         end
 
+        def config_param_sample
+          <<~SAMPLE
+            ```config.yml
+            plugin:
+              filters:
+                libinput_device_filter:
+                  keep_device_names:
+                    - "DEVICE NAME PATTERN"
+            ```
+          SAMPLE
+        end
+
         # Select Device to keep
         class KeepDevice
           def initialize(name_patterns:)
             @name_patterns = name_patterns | Array(self.class.from_option)
           end
 
+          attr_reader :name_patterns
+
           # remove cache for reloading new devices
           def reset
             @all = nil
@@ -56,9 +70,16 @@ module Fusuma
                        Device.all.select do |device|
                          match_pattern?(device.name)
                        end
+                     end.tap do |devices|
+                       print_not_found_messages if devices.empty?
                      end
           end
 
+          def print_not_found_messages
+            puts 'Device is not found. Check following section on your config.yml'
+            puts LibinputDeviceFilter.new.config_param_sample
+          end
+
           # @return [TrueClass]
           # @return [FalseClass]
           def match_pattern?(string)
@@ -68,8 +89,20 @@ module Fusuma
           end
 
           class << self
+            attr_reader :from_option
+
             # TODO: remove from_option and command line options
-            attr_accessor :from_option
+            def from_option=(device)
+              if device
+                warn <<~COMMENT
+                  Don't use --device="Device name" option because it is deprecated.
+                  Use the options below instead.
+
+                  #{LibinputDeviceFilter.new.config_param_sample}
+                COMMENT
+              end
+              @from_option = device
+            end
           end
         end
       end

data/lib/fusuma/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - iberianpig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-28 00:00:00.000000000 Z
+date: 2020-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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
@@ -185,6 +199,7 @@ files:
 - lib/fusuma/config.yml
 - lib/fusuma/config/index.rb
 - lib/fusuma/device.rb
+- lib/fusuma/environment.rb
 - lib/fusuma/libinput_command.rb
 - lib/fusuma/multi_logger.rb
 - lib/fusuma/plugin/base.rb
@@ -229,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Multitouch gestures with libinput dirver on X11, Linux