fusuma 1.10.1 → 2.0.0

data/lib/fusuma/plugin/executors/executor.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../base.rb'
+require_relative '../base'
 
 module Fusuma
   module Plugin
@@ -8,14 +8,56 @@ module Fusuma
     module Executors
       # Inherite this base
       class Executor < Base
+        BASE_ONESHOT_INTERVAL = 0.3
+        BASE_REPEAT_INTERVAL = 0.1
+
+        # Executor parameter on config.yml
+        # @return [Array<Symbol>]
+        def execute_keys
+          # [name.split('Executors::').last.underscore.gsub('_executor', '').to_sym]
+          raise NotImplementedError, "override #{name}##{__method__}"
+        end
+
         # check executable
-        # @param _event [Event]
+        # @param _event [Events::Event]
         # @return [TrueClass, FalseClass]
         def executable?(_event)
           raise NotImplementedError, "override #{self.class.name}##{__method__}"
         end
 
-        # execute somthing
+        # @param event [Events::Event]
+        # @param time [Time]
+        # @return [TrueClass, FalseClass]
+        def enough_interval?(event)
+          # NOTE: Cache at the index that is actually used, reflecting Fallback and Skip.
+          #       Otherwise, a wrong index will cause invalid intervals.
+          return true if event.record.index.with_context.keys.any? { |key| key.symbol == :end }
+
+          return false if @wait_until && event.time < @wait_until
+
+          true
+        end
+
+        def update_interval(event)
+          @wait_until = event.time + interval(event).to_f
+        end
+
+        def interval(event)
+          @interval_time ||= {}
+          index = event.record.index
+          @interval_time[index.cache_key] ||= begin
+            config_value =
+              Config.search(Config::Index.new([*index.keys, 'interval'])) ||
+              Config.search(Config::Index.new(['interval', Detectors::Detector.type(event.tag)]))
+            if event.record.trigger == :oneshot
+              (config_value || 1) * BASE_ONESHOT_INTERVAL
+            else
+              (config_value || 1) * BASE_REPEAT_INTERVAL
+            end
+          end
+        end
+
+        # execute something
         # @param _event [Event]
         # @return [nil]
         def execute(_event)

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../base.rb'
+require_relative '../base'
 
 module Fusuma
   module Plugin

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative './filter.rb'
-require_relative '../../device.rb'
+require_relative './filter'
+require_relative '../../device'
 
 module Fusuma
   module Plugin
@@ -25,15 +25,14 @@ module Fusuma
             keep_device.reset
             return false
           end
-
-          keep_device.all.map(&:id).any? { |device_id| record.to_s =~ /^\s?#{device_id}\s/ }
+          keep_device.all.map(&:id).any? { |device_id| record.to_s =~ /^[\s-]?#{device_id}\s/ }
         end
 
         def keep_device
           @keep_device ||= begin
-                             from_config = Array(config_params(:keep_device_names))
-                             KeepDevice.new(name_patterns: from_config)
-                           end
+            from_config = Array(config_params(:keep_device_names))
+            KeepDevice.new(name_patterns: from_config)
+          end
         end
 
         def config_param_sample

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative './filter.rb'
-require_relative '../../libinput_command.rb'
+require_relative './filter'
+require_relative '../../libinput_command'
 
 module Fusuma
   module Plugin

data/lib/fusuma/plugin/inputs/input.rb

@@ -1,22 +1,57 @@
 # frozen_string_literal: true
 
-require_relative '../base.rb'
-require_relative '../events/event.rb'
+require_relative '../base'
+require_relative '../events/event'
 
 module Fusuma
   module Plugin
-    # input class
     module Inputs
       # Inherite this base
+      # @abstract Subclass and override {#io} to implement
       class Input < Base
-        def run
+        # Wait multiple inputs until it becomes readable
+        # and read lines with nonblock
+        # @param inputs [Array<Input>]
+        # @return [Event]
+        def self.select(inputs)
+          ios = IO.select(inputs.map(&:io))
+          io = ios&.first&.first
+
+          input = inputs.find { |i| i.io == io }
+
+          begin
+            line = io.readline_nonblock("\n").chomp
+          rescue EOFError => e
+            warn "#{input.class.name}: #{e}"
+            warn 'Send SIGKILL to fusuma processes'
+            inputs.reject { |i| i == input }.each do |i|
+              warn "stop process: #{i.class.name.underscore}"
+              Process.kill(:SIGKILL, i.pid)
+            end
+            exit 1
+          rescue StandardError => e
+            warn "#{input.class.name}: #{e}"
+            exit 1
+          end
+
+          input.create_event(record: line)
+        end
+
+        # @return [Integer]
+        def pid
           raise NotImplementedError, "override #{self.class.name}##{__method__}"
         end
 
-        def event(record: 'dummy input')
-          Events::Event.new(tag: tag, record: record).tap do |e|
-            MultiLogger.debug(input_event: e)
-          end
+        # @return [IO]
+        def io
+          raise NotImplementedError, "override #{self.class.name}##{__method__}"
+        end
+
+        # @return [Event]
+        def create_event(record: 'dummy input')
+          e = Events::Event.new(tag: tag, record: record)
+          MultiLogger.debug(input_event: e)
+          e
         end
 
         def tag
@@ -26,3 +61,24 @@ module Fusuma
     end
   end
 end
+
+# ref: https://github.com/Homebrew/brew/blob/6b2dbbc96f7d8aa12f9b8c9c60107c9cc58befc4/Library/Homebrew/extend/io.rb
+class IO
+  def readline_nonblock(sep = $INPUT_RECORD_SEPARATOR)
+    line = +''
+    buffer = +''
+
+    loop do
+      break if buffer == sep
+
+      read_nonblock(1, buffer)
+      line.concat(buffer)
+    end
+
+    line.freeze
+  rescue IO::WaitReadable, EOFError => e
+    raise e if line.empty?
+
+    line.freeze
+  end
+end

data/lib/fusuma/plugin/inputs/libinput_command_input.rb

@@ -1,37 +1,47 @@
 # frozen_string_literal: true
 
-require_relative '../../libinput_command.rb'
-require_relative './input.rb'
+require_relative '../../libinput_command'
+require_relative './input'
 
 module Fusuma
   module Plugin
     module Inputs
       # libinput commands wrapper
       class LibinputCommandInput < Input
+        attr_reader :pid
+
         def config_param_types
           {
-            'device': [String],
+            device: [String],
             'enable-dwt': [TrueClass, FalseClass],
             'enable-tap': [TrueClass, FalseClass],
             'show-keycodes': [TrueClass, FalseClass],
-            'verbose': [TrueClass, FalseClass],
+            verbose: [TrueClass, FalseClass],
             'libinput-debug-events': [String],
             'libinput-list-devices': [String]
           }
         end
 
-        def run
-          LibinputCommand.new(
+        # @return [IO]
+        def io
+          @io ||= begin
+            @pid, io = command.debug_events
+            io
+          end
+        end
+
+        # @return [LibinputCommand]
+        def command
+          @command ||= LibinputCommand.new(
             libinput_options: libinput_options,
             commands: {
               debug_events_command: debug_events_command,
               list_devices_command: list_devices_command
             }
-          ).debug_events do |line|
-            yield event(record: line)
-          end
+          )
         end
 
+        # @return [Array]
         def libinput_options
           device = ("--device='#{config_params(:device)}'" if config_params(:device))
           enable_tap = '--enable-tap' if config_params(:'enable-tap')

data/lib/fusuma/plugin/inputs/timer_input.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative './input'
+
+module Fusuma
+  module Plugin
+    module Inputs
+      # libinput commands wrapper
+      class TimerInput < Input
+        DEFAULT_INTERVAL = 0.3
+        def config_param_types
+          {
+            interval: [Float]
+          }
+        end
+
+        attr_reader :pid
+
+        def io
+          @io ||= begin
+            reader, writer = create_io
+            @pid = start(reader, writer)
+
+            reader
+          end
+        end
+
+        def start(reader, writer)
+          pid = fork do
+            timer_loop(reader, writer)
+          end
+          Process.detach(pid)
+          writer.close
+          pid
+        end
+
+        def timer_loop(reader, writer)
+          reader.close
+          begin
+            loop do
+              sleep interval
+              writer.puts 'timer'
+            end
+          rescue Errno::EPIPE
+            exit 0
+          rescue StandardError => e
+            MultiLogger.error e
+          end
+        end
+
+        private
+
+        def create_io
+          IO.pipe
+        end
+
+        def interval
+          config_params(:interval) || DEFAULT_INTERVAL
+        end
+      end
+    end
+  end
+end

data/lib/fusuma/plugin/manager.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'pathname'
-require_relative '../multi_logger.rb'
+require_relative '../multi_logger'
+require_relative '../string_support'
 
 module Fusuma
   module Plugin
@@ -21,8 +21,19 @@ module Fusuma
       def require_siblings_from_gems
         search_key = File.join(plugin_dir_name, '*.rb')
         Gem.find_latest_files(search_key).each do |siblings_plugin|
-          if siblings_plugin =~ %r{fusuma-plugin-(.+).*/lib/#{plugin_dir_name}/\1_.+.rb}
+          next unless siblings_plugin =~ %r{fusuma-plugin-(.+).*/lib/#{plugin_dir_name}/\1_.+.rb}
+
+          match_data = siblings_plugin.match(%r{(.*)/(.*)/lib/(.*)})
+          gemspec_path = Dir.glob("#{match_data[1]}/#{match_data[2]}/*.gemspec").first
+          raise "Not Found: #{match_data[1]}/#{match_data[2]}/*.gemspec" unless gemspec_path
+
+          gemspec = Gem::Specification.load gemspec_path
+          fusuma_gemspec = Gem::Specification.load File.expand_path('../../../fusuma.gemspec',
+                                                                    __dir__)
+          if gemspec.dependencies.find { |d| d.name == 'fusuma' }&.match?(fusuma_gemspec)
             require siblings_plugin
+          else
+            MultiLogger.warn "#{gemspec.name} #{gemspec.version} is incompatible with running #{fusuma_gemspec.name} #{fusuma_gemspec.version}"
           end
         end
       end
@@ -58,14 +69,14 @@ module Fusuma
         end
 
         def require_base_plugins
-          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'
+          require_relative './base'
+          require_relative './events/event'
+          require_relative './inputs/input'
+          require_relative './filters/filter'
+          require_relative './parsers/parser'
+          require_relative './buffers/buffer'
+          require_relative './detectors/detector'
+          require_relative './executors/executor'
         end
 
         def plugins
@@ -90,21 +101,3 @@ module Fusuma
     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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../events/records/record.rb'
-require_relative '../events/records/gesture_record.rb'
+require_relative '../events/records/record'
+require_relative '../events/records/gesture_record'
 
 module Fusuma
   module Plugin
@@ -15,7 +15,7 @@ module Fusuma
         def parse_record(record)
           case line = record.to_s
           when /GESTURE_SWIPE|GESTURE_PINCH/
-            gesture, status, finger, direction = parse_libinput(line)
+            gesture, status, finger, delta = parse_libinput(line)
           else
             return
           end
@@ -23,7 +23,7 @@ module Fusuma
           Events::Records::GestureRecord.new(status: status,
                                              gesture: gesture,
                                              finger: finger,
-                                             direction: direction)
+                                             delta: delta)
         end
 
         private
@@ -32,8 +32,8 @@ module Fusuma
           _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]
+          delta = parse_delta(other)
+          [*detect_gesture(event_name), finger, delta]
         end
 
         def detect_gesture(event_name)
@@ -41,11 +41,13 @@ module Fusuma
           [Regexp.last_match(1).downcase, Regexp.last_match(2).downcase]
         end
 
-        def parse_direction(line)
+        def parse_delta(line)
           return if line.nil?
 
-          move_x, move_y, _, _, _, zoom, _, rotate = line.tr('/|(|)', ' ').split
+          move_x, move_y, unaccelerated_x, unaccelerated_y, _, zoom, _, rotate =
+            line.tr('/|(|)', ' ').split
           Events::Records::GestureRecord::Delta.new(move_x.to_f, move_y.to_f,
+                                                    unaccelerated_x.to_f, unaccelerated_y.to_f,
                                                     zoom.to_f, rotate.to_f)
         end
       end