fusuma 0.11.1 → 1.0

data/lib/fusuma/plugin/manager.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require_relative '../multi_logger.rb'
+
+module Fusuma
+  module Plugin
+    # Manage Fusuma plugins
+    class Manager
+      def initialize(plugin_class)
+        @plugin_class = plugin_class
+      end
+
+      def require_siblings_from_local
+        search_key = File.join('./lib', plugin_dir_name, '*.rb')
+        Dir.glob(search_key).each do |siblings_plugin|
+          require './' + siblings_plugin
+        end
+      end
+
+      def require_siblings_from_gems
+        search_key = File.join(plugin_dir_name, '*.rb')
+        Gem.find_files(search_key).each do |siblings_plugin|
+          if siblings_plugin =~ %r{fusuma-plugin-(.+).*/lib/#{plugin_dir_name}/\1_.+.rb}
+            require siblings_plugin
+          end
+        end
+      end
+
+      private
+
+      def plugin_dir_name
+        @plugin_class.name.match(/(Fusuma::.*)::/)[1].to_s.underscore
+      end
+
+      class << self
+        # @example
+        #  Manager.plugins
+        #  => {"Base"=>[Detectors::Detector],
+        #      "Detectors::Detector"=>[Detectors::RotateDetector,
+        #                              Detectors::PinchDetector,
+        #                              Detectors::SwipeDetector]}
+
+        # @param plugin_class [Class]
+        # return [Hash, false]
+        def add(plugin_class:, plugin_path:)
+          return false if exist?(plugin_class: plugin_class, plugin_path: plugin_path)
+
+          base = plugin_class.superclass.name
+          plugins[base] ||= []
+          plugins[base] << plugin_class
+
+          load_paths << plugin_path
+
+          manager = Manager.new(plugin_class)
+          manager.require_siblings_from_local
+          manager.require_siblings_from_gems
+        end
+
+        def require_plugins_from_relative
+          require_relative './base.rb'
+          require_relative './events/event.rb'
+          require_relative './inputs/input.rb'
+          require_relative './filters/filter.rb'
+          require_relative './parsers/parser.rb'
+          require_relative './buffers/buffer.rb'
+          require_relative './detectors/detector.rb'
+          require_relative './executors/executor.rb'
+        end
+
+        def require_plugins_from_config
+          local_plugin_paths = Config.search(Config::Index.new('local_plugin_paths'))
+          return unless local_plugin_paths
+
+          Array.new(local_plugin_paths).each do |plugin_path|
+            require plugin_path
+          end
+        end
+
+        def plugins
+          @plugins ||= {}
+        end
+
+        def load_paths
+          @load_paths ||= []
+        end
+
+        # @param plugin_class [Class]
+        # @return [Boolean]
+        def exist?(plugin_class:, plugin_path:)
+          return false if load_paths.include?(plugin_path)
+
+          base = plugin_class.superclass.name
+          return false unless plugins[base]
+
+          plugins[base].include?(plugin_class)
+        end
+      end
+    end
+  end
+end
+
+# support camerize and underscore
+class String
+  def camerize
+    split('_').map do |w|
+      w[0].upcase!
+      w
+    end.join
+  end
+
+  def underscore
+    gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+      .gsub('::', '/')
+      .tr('-', '_')
+      .downcase
+  end
+end

data/lib/fusuma/plugin/parsers/libinput_gesture_parser.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative '../events/records/record.rb'
+require_relative '../events/records/gesture_record.rb'
+
+module Fusuma
+  module Plugin
+    module Parsers
+      # parse libinput and generate gesture record
+      class LibinputGestureParser < Parser
+        DEFAULT_SOURCE = 'libinput_command_input'
+
+        # @param record [String]
+        # @return [Records::GestureRecord, nil]
+        def parse_record(record)
+          case line = record.to_s
+          when /GESTURE_SWIPE|GESTURE_PINCH/
+            gesture, status, finger, direction = parse_libinput(line)
+          else
+            return
+          end
+
+          Events::Records::GestureRecord.new(status: status,
+                                             gesture: gesture,
+                                             finger: finger,
+                                             direction: direction)
+        end
+
+        private
+
+        def parse_libinput(line)
+          _device, event_name, _time, other = line.strip.split(nil, 4)
+          finger, other = other.split(nil, 2)
+
+          direction = parse_direction(other)
+          [*detect_gesture(event_name), finger, direction]
+        end
+
+        def detect_gesture(event_name)
+          event_name =~ /GESTURE_(SWIPE|PINCH)_(BEGIN|UPDATE|END)/
+          [Regexp.last_match(1).downcase, Regexp.last_match(2).downcase]
+        end
+
+        def parse_direction(line)
+          return if line.nil?
+
+          move_x, move_y, _, _, _, zoom, _, rotate = line.tr('/|(|)', ' ').split
+          Events::Records::GestureRecord::Delta.new(move_x.to_f, move_y.to_f,
+                                                    zoom.to_f, rotate.to_f)
+        end
+      end
+    end
+  end
+end

data/lib/fusuma/plugin/parsers/parser.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative '../base.rb'
+
+module Fusuma
+  module Plugin
+    module Parsers
+      # Parser change record and tag in event
+      # Inherite this base class
+      class Parser < Base
+        # Parse Event and convert Record and Tag
+        # if `#parse_record` return nil, this method will return original event
+        # @param event [Event]
+        # @return [Event]
+        def parse(event)
+          event.tap do |e|
+            next if e.tag != source
+
+            new_record = parse_record(e.record)
+            next unless new_record
+
+            e.record = new_record
+            e.tag = tag
+          end
+        end
+
+        # Set source for tag from config.yml.
+        # DEFAULT_SOURCE is defined in each Parser plugins.
+        def source
+          @source ||= config_params(:source) || self.class.const_get('DEFAULT_SOURCE')
+        end
+
+        def tag
+          self.class.name.split('::').last.underscore
+        end
+
+        # parse Record object
+        # @param _record [Record]
+        # @return [Record, nil]
+        def parse_record(_record)
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/fusuma/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fusuma
-  VERSION = '0.11.1'.freeze
+  VERSION = '1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: '1.0'
 platform: ruby
 authors:
 - iberianpig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-27 00:00:00.000000000 Z
+date: 2019-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,20 +52,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  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: pry-inline
+  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: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
@@ -108,8 +136,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-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
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+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).
 email:
 - yhkyky@gmail.com
@@ -118,6 +160,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/stale.yml"
@@ -138,21 +181,38 @@ files:
 - exe/fusuma
 - fusuma.gemspec
 - lib/fusuma.rb
-- lib/fusuma/command_executor.rb
 - lib/fusuma/config.rb
 - lib/fusuma/config.yml
+- lib/fusuma/config/index.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
+- lib/fusuma/plugin/base.rb
+- lib/fusuma/plugin/buffers/buffer.rb
+- lib/fusuma/plugin/buffers/gesture_buffer.rb
+- lib/fusuma/plugin/detectors/detector.rb
+- lib/fusuma/plugin/detectors/pinch_detector.rb
+- lib/fusuma/plugin/detectors/rotate_detector.rb
+- lib/fusuma/plugin/detectors/swipe_detector.rb
+- lib/fusuma/plugin/events/event.rb
+- lib/fusuma/plugin/events/records/gesture_record.rb
+- lib/fusuma/plugin/events/records/index_record.rb
+- lib/fusuma/plugin/events/records/record.rb
+- lib/fusuma/plugin/events/records/text_record.rb
+- lib/fusuma/plugin/executors/command_executor.rb
+- lib/fusuma/plugin/executors/executor.rb
+- lib/fusuma/plugin/filters/filter.rb
+- lib/fusuma/plugin/filters/libinput_device_filter.rb
+- lib/fusuma/plugin/inputs/input.rb
+- lib/fusuma/plugin/inputs/libinput_command_input.rb
+- lib/fusuma/plugin/manager.rb
+- lib/fusuma/plugin/parsers/libinput_gesture_parser.rb
+- lib/fusuma/plugin/parsers/parser.rb
 - lib/fusuma/version.rb
 homepage: https://github.com/iberianpig/fusuma
 licenses:
 - MIT
-metadata: {}
+metadata:
+  yard.run: yri
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -161,7 +221,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/fusuma/command_executor.rb

@@ -1,43 +0,0 @@
-module Fusuma
-  # Execute Command
-  class CommandExecutor
-    def initialize(finger, vector)
-      @finger      = finger.to_i
-      @direction   = vector.direction
-      @event_type = vector.class::TYPE
-    end
-    attr_reader :finger, :direction, :event_type
-
-    def execute
-      pid = fork {
-        Process.daemon(true)
-        exec("#{command_or_shortcut}")
-      }
-      Process.detach(pid)
-      MultiLogger.info("Execute: #{command_or_shortcut}")
-    end
-
-    private
-
-    def command_or_shortcut
-      @command_or_shortcut ||= command || shortcut || no_command
-    end
-
-    def command
-      Config.command(self)
-    end
-
-    def shortcut
-      s = Config.shortcut(self)
-      return unless s
-      c = "xdotool key #{s}"
-      MultiLogger.warn 'shortcut property is deprecated.'
-      MultiLogger.warn "Use command: #{c} instead of shortcut: #{s}"
-      c
-    end
-
-    def no_command
-      'echo "Command is not assigned"'
-    end
-  end
-end

data/lib/fusuma/event_stack.rb

@@ -1,87 +0,0 @@
-module Fusuma
-  # manage events and generate command
-  class EventStack < Array
-    ELAPSED_TIME = 0.01
-
-    def initialize(*args)
-      super(*args)
-    end
-
-    # @return [CommandExecutor, nil]
-    def generate_command_executor
-      return unless enough_events?
-      vector = generate_vector(detect_event_type)
-      trigger = CommandExecutor.new(finger, vector)
-      return unless vector.enough?(trigger)
-      clear
-      trigger
-    end
-
-    # @params [GestureEvent]
-    def push(gesture_event)
-      super(gesture_event)
-      clear if event_end?
-    end
-    alias << push
-
-    private
-
-    def generate_vector(event_type)
-      case event_type
-      when 'swipe'
-        avg_swipe
-      when 'pinch'
-        avg_pinch
-      end
-    end
-
-    def finger
-      last.finger
-    end
-
-    def avg_swipe
-      move_x = avg_attrs(:move_x)
-      move_y = avg_attrs(:move_y)
-      Swipe.new(move_x, move_y)
-    end
-
-    def avg_pinch
-      diameter = avg_attrs(:zoom)
-      delta_diameter = diameter - first.zoom
-      Pinch.new(delta_diameter)
-    end
-
-    def sum_attrs(attr)
-      send('map') do |gesture_event|
-        gesture_event.send(attr.to_sym.to_s)
-      end.compact.inject(:+)
-    end
-
-    def avg_attrs(attr)
-      sum_attrs(attr) / length
-    end
-
-    def event_end?
-      last_event_name =~ /_END$/
-    end
-
-    def last_event_name
-      return false if last.class != GestureEvent
-      last.event
-    end
-
-    def enough_events?
-      length > 2
-    end
-
-    def enough_elapsed_time?
-      return false if length.zero?
-      (last.time - first.time) > ELAPSED_TIME
-    end
-
-    def detect_event_type
-      first.event =~ /GESTURE_(.*?)_/
-      Regexp.last_match(1).downcase
-    end
-  end
-end