fusuma 0.11.1 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fe44afd179f0f4d30a1ebe074fd4d3794870ca417185bfdb3bb29254ad3a42e
-  data.tar.gz: f7096bf6a130e9e0c3100ea6895090c629542397d5379696910045c5982bb568
+  metadata.gz: 80d93508637448b749150766ad39d75fffa6b993600ff40d3c95129fee193ba0
+  data.tar.gz: 408a2ab6bbe496f5a7d989400e3598fc9aa9371e9c13e6a9fc4e5b915033efbb
 SHA512:
-  metadata.gz: 377f1415db80a150b9e725014585f015351376449eebf4f40b283c43d7cc53e1cd70e53ce26616172cdcc668a162e03e711f30a75871e208acf02da60ed539b7
-  data.tar.gz: 6d5d7cb06e0d550fb8794b34671e65a89e321addc18866637c98c8b98cf966b2694de3279da505a2c9d7dbb01014f926fbd5ace4e90d50a870831232b7835271
+  metadata.gz: 8bbc0dbaee8c103c2d2c8d506975d85d531ba14ca204c886f2d95a6b7812f133e97e45e418086290b07e4f0aad653bf15296a1b4f7e74b63f25d02d9f4a89553
+  data.tar.gz: 71746fc05185021c81e54ff4956895b7e8e1644638a1b0e5917b86864175cd544085e90bf9422fb3910ecc33b8d199295ade1198eb5122b61856e5dcb58b9358

data/.github/FUNDING.yml

@@ -0,0 +1,8 @@
+# These are supported funding model platforms
+
+github: # [iberianpig] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: iberianpig # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+custom: # Replace with a single custom sponsorship URL

data/.gitignore

@@ -7,3 +7,9 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# todo
+todo.md

data/.reek.yml

@@ -1,48 +1,96 @@
----
-
-### Generic smell configuration
 
+---
+### enabled rules
 detectors:
-#   # You can disable smells completely
-#   IrresponsibleModule:
-#     enabled: false
-  UncommunicativeVariableName:
-      enabled: false
+  TooManyInstanceVariables:
+    enabled: true
+    exclude: []
+    max_instance_variables: 50
+  TooManyMethods:
+    enabled: true
+    exclude: []
+    max_methods: 30
+  TooManyStatements:
+    enabled: true
+    exclude: []
+    max_statements: 80
+  TooManyConstants:
+    enabled: true
+    exclude: []
+    max_constants: 50
+  LongParameterList:
+    enabled: true
+    exclude: []
+    max_params: 8
+  LongYieldList:
+    enabled: true
+    exclude: []
+    max_params: 8
+  NestedIterators:
+    enabled: true
+    exclude: []
+    max_allowed_nesting: 5
+    ignore_iterators:
+    - tap
+  ModuleInitialize:
+    enabled: true
+    exclude: []
+  SubclassedFromCoreClass:
+    enabled: true
+    exclude: []
 
-#
-#   # You can use filters to silence Reek warnings.
-#   # Either because you simply disagree with Reek (we are not the police) or
-#   # because you want to fix this at a later point in time.
-#   NestedIterators:
-#     exclude:
-#       - "MyWorker#self.class_method" # should be refactored
-#       - "AnotherWorker#instance_method" # should be refactored as well
-#
-#   # A lot of smells allow fine tuning their configuration. You can look up all available options
-#   # in the corresponding smell documentation in /docs. In most cases you probably can just go
-#   # with the defaults as documented in defaults.reek.yml.
-#   DataClump:
-#     max_copies: 3
-#     min_clump_size: 3
-
-
-# ### Directory specific configuration
-#
-# # You can configure smells on a per-directory base.
-# # E.g. the classic Rails case: controllers smell of NestedIterators (see /docs/Nested-Iterators.md) and
-# # helpers smell of UtilityFunction (see docs/Utility-Function.md)
-# # Note that we only allow configuration on a directory level, not a file level, so all paths have to point to directories.
-# directories:
-#   "web_app/app/controllers":
-#     NestedIterators:
-#       enabled: false
-#   "web_app/app/helpers":
-#     UtilityFunction:
-#       enabled: false
-
-# ### Excluding directories
-#
-# # Directories below will not be scanned at all
-# exclude_paths:
-#   - lib/legacy
-#   - lib/rake/legacy_tasks
+  ### unanabled rules
+  Attribute:
+    enabled: false
+    exclude: []
+  BooleanParameter:
+    enabled: false
+    exclude: []
+  ClassVariable:
+    enabled: false
+    exclude: []
+  ControlParameter:
+    enabled: false
+    exclude: []
+  DataClump:
+    enabled: false
+    exclude: []
+  DuplicateMethodCall:
+    enabled: false
+    exclude: []
+  FeatureEnvy:
+    enabled: false
+    exclude: []
+  InstanceVariableAssumption:
+    enabled: false
+    exclude: []
+  IrresponsibleModule:
+    enabled: false
+    exclude: []
+  ManualDispatch:
+    enabled: false
+    exclude: []
+  NilCheck:
+    enabled: false
+    exclude: []
+  RepeatedConditional:
+    enabled: false
+    exclude: []
+  UncommunicativeMethodName:
+    enabled: false
+    exclude: []
+  UncommunicativeModuleName:
+    enabled: false
+    exclude: []
+  UncommunicativeParameterName:
+    enabled: false
+    exclude: []
+  UncommunicativeVariableName:
+    enabled: false
+    exclude: []
+  UnusedParameters:
+    enabled: false
+    exclude: []
+  UtilityFunction:
+    enabled: false
+    exclude: []

data/.rubocop.yml

@@ -7,7 +7,9 @@ Metrics/ModuleLength:
 Metrics/BlockLength:
   Exclude:
     - "**/*_spec.rb"
+    - "fusuma.gemspec"
 
 Metrics/LineLength:
+  Max: 100
   Exclude:
     - "fusuma.gemspec"

data/.rubocop_todo.yml

@@ -1,60 +1,28 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-05-24 12:59:49 +0900 using RuboCop version 0.70.0.
+# on 2019-08-12 15:52:49 +0900 using RuboCop version 0.74.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: 3
-# Cop supports --auto-correct.
-# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
-# SupportedHashRocketStyles: key, separator, table
-# SupportedColonStyles: key, separator, table
-# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
-Layout/AlignHash:
-  Exclude:
-    - 'spec/lib/config_spec.rb'
-
-# Offense count: 20
-# Cop supports --auto-correct.
-Layout/EmptyLineAfterGuardClause:
-  Exclude:
-    - 'lib/fusuma.rb'
-    - 'lib/fusuma/command_executor.rb'
-    - 'lib/fusuma/config.rb'
-    - 'lib/fusuma/device.rb'
-    - 'lib/fusuma/event_stack.rb'
-    - 'lib/fusuma/gesture_event.rb'
-    - 'lib/fusuma/libinput_commands.rb'
-    - 'lib/fusuma/multi_logger.rb'
-    - 'lib/fusuma/pinch.rb'
-    - 'lib/fusuma/swipe.rb'
+Metrics/AbcSize:
+  Max: 25
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: PreferredName.
-Naming/RescuedExceptionsVariableName:
-  Exclude:
-    - 'lib/fusuma/device.rb'
+# Offense count: 6
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 15
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods, AllowBracesOnProceduralOneLiners.
-# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
-# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
-# FunctionalMethods: let, let!, subject, watch
-# IgnoredMethods: lambda, proc, it
-Style/BlockDelimiters:
+# Offense count: 3
+Style/Documentation:
   Exclude:
-    - 'lib/fusuma/command_executor.rb'
-
-# Offense count: 23
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: always, never
-Style/FrozenStringLiteralComment:
-  Enabled: false
+    - 'spec/**/*'
+    - 'test/**/*'
+    - '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.
@@ -63,32 +31,5 @@ Style/FrozenStringLiteralComment:
 Style/NumericPredicate:
   Exclude:
     - 'spec/**/*'
-    - 'lib/fusuma/pinch.rb'
-    - 'lib/fusuma/swipe.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: ConvertCodeThatCanStartToReturnNil, Whitelist.
-# Whitelist: present?, blank?, presence, try, try!
-Style/SafeNavigation:
-  Exclude:
-    - 'lib/fusuma.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/UnneededInterpolation:
-  Exclude:
-    - 'lib/fusuma/command_executor.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/UnneededPercentQ:
-  Exclude:
-    - 'spec/lib/command_executor_spec.rb'
-
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 87
+    - 'lib/fusuma/plugin/detectors/rotate_detector.rb'
+    - 'lib/fusuma/plugin/detectors/swipe_detector.rb'

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in fusuma.gemspec

data/README.md

@@ -1,7 +1,7 @@
 # Fusuma [![Gem Version](https://badge.fury.io/rb/fusuma.svg)](https://badge.fury.io/rb/fusuma) [![Build Status](https://travis-ci.org/iberianpig/fusuma.svg?branch=master)](https://travis-ci.org/iberianpig/fusuma)
 
 Fusuma is multitouch gesture recognizer.
-This gem makes your linux PC able to recognize swipes or pinchs and assign commands to them.
+This gem makes your linux able to recognize swipes or pinchs and assign commands to them.
 
 ![fusuma_image](https://i.gyazo.com/757fef526310b9d68f68e80eb1e4540f.png)
 
@@ -16,7 +16,7 @@ This gem makes your linux PC able to recognize swipes or pinchs and assign comma
 $ sudo gpasswd -a $USER input
 ```
 
-Then, You **MUST** **LOGOUT/LOGIN or REBOOT** to assign this group.
+Then, You **MUST** **REBOOT** to assign this group.
 
 ### 2. Install libinput-tools
 You need `libinput` release 1.0 or later.
@@ -25,13 +25,20 @@ You need `libinput` release 1.0 or later.
 $ sudo apt-get install libinput-tools
 ```
 
-### 3. Install Fusuma
+### 3. Install Ruby
+Fusuma runs in Ruby, so you must install it first.
+
+```bash
+$ sudo apt-get install ruby
+```
+
+### 4. Install Fusuma
 
 ```bash
 $ sudo gem install fusuma
 ```
 
-### 4. Install xdotool(optional)
+### 5. Install xdotool (optional)
 
 For sending shortcuts:
 ```bash
@@ -126,7 +133,7 @@ swipe:
       command: 'xdotool key super'
   4:
     up:
-      command: 'xdptool key super+m'
+      command: 'xdotool key super+m'
     down:
       command: 'xdotool key super+m'
 pinch:

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
@@ -5,7 +7,6 @@ RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
 
-
 require 'github_changelog_generator/task'
 
 GitHubChangelogGenerator::RakeTask.new :changelog do |config|

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'fusuma'
@@ -8,5 +9,4 @@ require 'fusuma'
 
 # (If you use this, don't forget to add pry to your Gemfile!)
 require 'pry'
-require 'pry-byebug'
 Pry.start

data/exe/fusuma

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'optparse'
 require_relative '../lib/fusuma'

data/fusuma.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fusuma/version'
@@ -9,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['yhkyky@gmail.com']
 
   spec.summary       = 'Multitouch gestures with libinput dirver on X11, Linux'
-  spec.description   = 'Fusuma is multitouch gesture recognizer. This gem makes your linux PC able to recognize swipes or pinchs and assign command to them. Read installation on Github(https://github.com/iberianpig/fusuma#installation).'
+  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'
 
@@ -19,12 +21,17 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   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 'github_changelog_generator', '~> 1.14'
   spec.add_development_dependency 'pry-byebug', '~> 3.4'
-  spec.add_development_dependency 'rake', '~> 12.3'
+  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'
 end

data/lib/fusuma.rb

@@ -1,16 +1,10 @@
-require_relative 'fusuma/version'
-require_relative 'fusuma/event_stack'
-require_relative 'fusuma/gesture_event'
-require_relative 'fusuma/command_executor'
-require_relative 'fusuma/swipe.rb'
-require_relative 'fusuma/pinch.rb'
-require_relative 'fusuma/multi_logger'
-require_relative 'fusuma/config.rb'
-require_relative 'fusuma/device.rb'
-require_relative 'fusuma/libinput_commands.rb'
-require 'logger'
-require 'open3'
-require 'yaml'
+# frozen_string_literal: true
+
+require_relative './fusuma/version'
+require_relative './fusuma/multi_logger'
+require_relative './fusuma/config.rb'
+require_relative './fusuma/device.rb'
+require_relative './fusuma/plugin/manager.rb'
 
 # this is top level module
 module Fusuma
@@ -32,53 +26,116 @@ module Fusuma
       end
 
       def read_options(option)
-        print_version && exit(0) if option[:version]
+        MultiLogger.instance.debug_mode = option[:verbose]
+
+        load_custom_config(option[:config_path])
+
+        Plugin::Manager.require_plugins_from_relative
+        Plugin::Manager.require_plugins_from_config
+
+        print_version(then_exit: option[:version])
+        print_enabled_plugins
+
         print_device_list if option[:list]
-        reload_custom_config(option[:config_path])
-        debug_mode if option[:verbose]
-        Device.given_device = option[:device]
+        Device.given_devices = option[:device]
         Process.daemon if option[:daemon]
       end
 
-      def print_version
+      # TODO: print after reading plugins
+      def print_version(then_exit: false)
         MultiLogger.info '---------------------------------------------'
         MultiLogger.info "Fusuma: #{Fusuma::VERSION}"
-        MultiLogger.info "libinput: #{LibinputCommands.new.version}"
+        MultiLogger.info "libinput: #{Plugin::Inputs::LibinputCommandInput.new.version}"
         MultiLogger.info "OS: #{`uname -rsv`}".strip
         MultiLogger.info "Distribution: #{`cat /etc/issue`}".strip
         MultiLogger.info "Desktop session: #{`echo $DESKTOP_SESSION`}".strip
         MultiLogger.info '---------------------------------------------'
+        Kernel.exit(0) if then_exit
+      end
+
+      def print_enabled_plugins
+        MultiLogger.debug '---------------------------------------------'
+        MultiLogger.debug 'Enabled Plugins: '
+        Plugin::Manager.plugins
+                       .reject { |k, _v| k.to_s =~ /Base/ }
+                       .map { |_base, plugins| plugins.map { |plugin| "  #{plugin}" } }
+                       .flatten.sort.each { |name| MultiLogger.debug name }
+        MultiLogger.debug '---------------------------------------------'
       end
 
       def print_device_list
-        puts Device.names
+        puts Device.available.map(&:name)
         exit(0)
       end
 
-      def reload_custom_config(config_path = nil)
+      def load_custom_config(config_path = nil)
         return unless config_path
-        MultiLogger.info "use custom path: #{config_path}"
-        Config.instance.custom_path = config_path
-        Config.reload
+
+        Config.custom_path = config_path
       end
 
       def debug_mode
-        print_version
         MultiLogger.instance.debug_mode = true
+        print_version
       end
     end
 
     def initialize
-      @event_stack = EventStack.new
+      @inputs = Plugin::Inputs::Input.plugins.map(&:new)
+      @filters = Plugin::Filters::Filter.plugins.map(&:new)
+      @parsers = Plugin::Parsers::Parser.plugins.map(&:new)
+      @buffers = Plugin::Buffers::Buffer.plugins.map(&:new)
+      @detectors = Plugin::Detectors::Detector.plugins.map(&:new)
+      @executors = Plugin::Executors::Executor.plugins.map(&:new)
     end
 
     def run
-      LibinputCommands.new.debug_events do |line|
-        gesture_event = GestureEvent.initialize_by(line.to_s, Device.ids)
-        next unless gesture_event
-        @event_stack << gesture_event
-        @event_stack.generate_command_executor.tap { |c| c.execute if c }
+      # TODO: run with multi thread
+      @inputs.first.run do |event|
+        filtered = filter(event)
+        parsed = parse(filtered)
+        buffered = buffer(parsed)
+        detected = detect(buffered)
+        execute(detected)
+      end
+    end
+
+    def filter(event)
+      @filters.reduce(event) { |e, f| f.filter(e) if e }
+    end
+
+    def parse(event)
+      @parsers.reduce(event) { |e, p| p.parse(e) if e  }
+    end
+
+    def buffer(event)
+      @buffers.each { |b| b.buffer(event) }
+    end
+
+    # @param buffers [Array<Buffer>]
+    # @return [Event] if event is detected
+    # @return [NilClass] if event is NOT detected
+    def detect(buffers)
+      @detectors.each_with_object([]) do |detector, index_records|
+        event = detector.detect(buffers) # event
+
+        if event&.record&.mergable?
+          event.record.merge(records: index_records)
+          buffers.each(&:clear) # clear buffer
+          break(event)
+        end
+
+        break nil if @detectors.last == detector
+      end
+    end
+
+    def execute(event)
+      return unless event
+
+      executor = @executors.find do |e|
+        e.executable?(event)
       end
+      executor&.execute(event)
     end
   end
 end