fusuma 1.10.1 → 2.0.0

data/lib/fusuma/config/yaml_duplication_checker.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Fusuma
+  class Config
+    # ref: https://github.com/rubocop-hq/rubocop/blob/97e4ffc8a71e9e5239a927c6a534dfc1e0da917f/lib/rubocop/yaml_duplication_checker.rb
+    # Find duplicated keys from YAML.
+    module YAMLDuplicationChecker
+      def self.check(yaml_string, filename, &on_duplicated)
+        # Ruby 2.6+
+        tree = if Gem::Version.new(Psych::VERSION) >= Gem::Version.new('3.1.0')
+                 # Specify filename to display helpful message when it raises
+                 # an error.
+                 YAML.parse(yaml_string, filename: filename)
+               else
+                 YAML.parse(yaml_string, filename)
+               end
+        return unless tree
+
+        traverse(tree, &on_duplicated)
+      end
+
+      def self.traverse(tree, &on_duplicated)
+        case tree
+        when Psych::Nodes::Mapping
+          tree.children.each_slice(2).with_object([]) do |(key, value), keys|
+            exist = keys.find { |key2| key2.value == key.value }
+            on_duplicated.call(exist, key) if exist
+            keys << key
+            traverse(value, &on_duplicated)
+          end
+        else
+          children = tree.children
+          return unless children
+
+          children.each { |c| traverse(c, &on_duplicated) }
+        end
+      end
+
+      private_class_method :traverse
+    end
+  end
+end

data/lib/fusuma/custom_process.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Fusuma
+  # Rename process
+  module CustomProcess
+    def fork
+      Process.fork do
+        Process.setproctitle(self.class.name.underscore.to_s)
+        yield
+      end
+    end
+  end
+end

data/lib/fusuma/device.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
 
 require_relative './multi_logger'
-require_relative './libinput_command.rb'
+require_relative './libinput_command'
 
 module Fusuma
   # detect input device
   class Device
-    attr_reader :available
-    attr_reader :name
-    attr_reader :id
+    attr_reader :id, :name, :capabilities, :available
 
-    def initialize(id: nil, name: nil, available: nil)
+    def initialize(id: nil, name: nil, capabilities: nil, available: nil)
       @id = id
       @name = name
+      @capabilities = capabilities
       @available = available
     end
 
@@ -24,6 +23,8 @@ module Fusuma
           @id = v
         when :name
           @name = v
+        when :capabilities
+          @capabilities = v
         when :available
           @available = v
         end
@@ -31,9 +32,13 @@ module Fusuma
     end
 
     class << self
+      # Return devices
+      # sort devices by capabilities of gesture
       # @return [Array]
       def all
-        @all ||= fetch_devices
+        @all ||= fetch_devices.partition do |d|
+          d.capabilities.match?(/gesture/)
+        end.flatten
       end
 
       # @raise [SystemExit]
@@ -59,7 +64,9 @@ module Fusuma
       # @return [Array]
       def fetch_devices
         line_parser = LineParser.new
-        LibinputCommand.new.list_devices do |line|
+
+        libinput_command = Plugin::Inputs::LibinputCommandInput.new.command
+        libinput_command.list_devices do |line|
           line_parser.push(line)
         end
         line_parser.generate_devices
@@ -102,6 +109,8 @@ module Fusuma
           { id: id }
         elsif (name = name_from(line))
           { name: name }
+        elsif (capabilities = capabilities_from(line))
+          { capabilities: capabilities }
         elsif (available = available_from(line))
           { available: available }
         else
@@ -121,6 +130,12 @@ module Fusuma
         end
       end
 
+      def capabilities_from(line)
+        line.match('^Capabilities:[[:space:]]*') do |m|
+          m.post_match.strip
+        end
+      end
+
       def available_from(line)
         # NOTE: is natural scroll available?
         if line =~ /^Nat.scrolling: /

data/lib/fusuma/environment.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative './version.rb'
-require_relative './libinput_command.rb'
-require_relative './multi_logger.rb'
+require_relative './version'
+require_relative './libinput_command'
+require_relative './multi_logger'
 
 module Fusuma
   # Output Environment information
@@ -17,8 +17,10 @@ module Fusuma
       end
 
       def print_version
+        libinput_command = Plugin::Inputs::LibinputCommandInput.new.command
         MultiLogger.info "Fusuma: #{VERSION}"
-        MultiLogger.info "libinput: #{LibinputCommand.new.version}"
+        MultiLogger.info "libinput: #{libinput_command.version}"
+        MultiLogger.info "ruby #{ RUBY_VERSION }p#{ RUBY_PATCHLEVEL }"
         MultiLogger.info "OS: #{`uname -rsv`}".strip
         MultiLogger.info "Distribution: #{`cat /etc/issue`}".strip
         MultiLogger.info "Desktop session: #{`echo $DESKTOP_SESSION $XDG_SESSION_TYPE`}".strip

data/lib/fusuma/hash_support.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Patch to hash
+class Hash
+  # activesupport-4.1.1/lib/active_support/core_ext/hash/keys.rb
+  def deep_symbolize_keys
+    deep_transform_keys do |key|
+      key.to_sym
+    rescue StandardError
+      key
+    end
+  end
+
+  def deep_transform_keys(&block)
+    result = {}
+    each do |key, value|
+      result[yield(key)] = value.is_a?(Hash) ? value.deep_transform_keys(&block) : value
+    end
+    result
+  end
+
+  # activesupport/lib/active_support/core_ext/hash/deep_transform_values.rb
+  def deep_transform_values(&block)
+    _deep_transform_values_in_object(self, &block)
+  end
+
+  private
+
+  # Support methods for deep transforming nested hashes and arrays.
+  def _deep_transform_values_in_object(object, &block)
+    case object
+    when Hash
+      object.transform_values { |value| _deep_transform_values_in_object(value, &block) }
+    when Array
+      object.map { |e| _deep_transform_values_in_object(e, &block) }
+    else
+      yield(object)
+    end
+  end
+end

data/lib/fusuma/libinput_command.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'open3'
-require 'timeout'
+require 'posix/spawn'
 
 module Fusuma
   # Execute libinput command
@@ -31,40 +30,37 @@ module Fusuma
     end
 
     # @yieldparam [String] gives a line in libinput list-devices output to the block
-    def list_devices
+    def list_devices(&block)
       cmd = list_devices_command
       MultiLogger.debug(list_devices: cmd)
-      Open3.popen3(cmd) do |_i, o, _e, _w|
-        o.each { |line| yield(line) }
-      end
+      p, i, o, e = POSIX::Spawn.popen4(cmd)
+      i.close
+      o.each(&block)
+    ensure
+      [i, o, e].each { |io| io.close unless io.closed? }
+      Process.waitpid(p)
     end
 
-    # @yieldparam [String] gives a line in libinput debug-events output to the block
+    # @return [Integer, IO] return a latest line libinput debug-events
     def debug_events
-      MultiLogger.debug(debug_events: debug_events_with_options)
-      Open3.popen3(debug_events_with_options) do |_i, o, _e, _w|
-        loop do
-          line = begin
-                   Timeout.timeout(wait_time) do
-                     o.readline.chomp
-                   end
-                 rescue Timeout::Error
-                   TIMEOUT_MESSAGE
-                 end
-          yield(line)
-        end
+      @debug_events = begin
+        p, i, o, _e = POSIX::Spawn.popen4(debug_events_with_options)
+        i.close
+        [p, o]
       end
     end
 
     # @return [String] command
     # @raise [SystemExit]
     def version_command
-      if which('libinput')
+      if @debug_events_command && @list_devices_command
+        "#{@list_devices_command} --version"
+      elsif which('libinput')
         'libinput --version'
       elsif which('libinput-list-devices')
         'libinput-list-devices --version'
       else
-        MultiLogger.error 'install libinput-tools'
+        MultiLogger.error 'Please install libinput-tools'
         exit 1
       end
     end

data/lib/fusuma/multi_logger.rb

@@ -12,15 +12,11 @@ module Fusuma
     attr_accessor :debug_mode
 
     def initialize
-      super(STDOUT)
-      @err_logger = Logger.new(STDERR)
+      super($stdout)
+      @err_logger = Logger.new($stderr)
       @debug_mode = false
     end
 
-    def info(msg)
-      super(msg)
-    end
-
     def debug(msg)
       return unless debug_mode?
 

data/lib/fusuma/plugin/base.rb

@@ -1,22 +1,23 @@
 # frozen_string_literal: true
 
-require_relative './manager.rb'
-require_relative '../config.rb'
+require_relative './manager'
+require_relative '../config'
+require_relative '../custom_process'
 
 module Fusuma
   module Plugin
     # Create a Plugin Class with extending this class
     class Base
+      include CustomProcess
       # when inherited from subclass
       def self.inherited(subclass)
+        super
         subclass_path = caller_locations(1..1).first.path
         Manager.add(plugin_class: subclass, plugin_path: subclass_path)
       end
 
-      # get inherited classes
-      # @example
-      #  [Vectors::Vector]
-      # @return [Array]
+      # get subclasses
+      # @return [Array<Class>]
       def self.plugins
         Manager.plugins[name]
       end
@@ -33,19 +34,21 @@ module Fusuma
 
         return params unless key
 
-        params.fetch(key, nil).tap do |val|
-          next if val.nil?
+        @config_params ||= {}
+        @config_params["#{base.cache_key},#{key}"] ||=
+          params.fetch(key, nil).tap do |val|
+            next if val.nil?
 
-          # NOTE: Type checking for config.yml
-          param_types = Array(config_param_types.fetch(key))
+            # NOTE: Type checking for config.yml
+            param_types = Array(config_param_types.fetch(key))
 
-          next if param_types.any? { |klass| val.is_a?(klass) }
+            next if param_types.any? { |klass| val.is_a?(klass) }
 
-          MultiLogger.error('Please fix config.yml.')
-          MultiLogger.error(":#{base.keys.map(&:symbol)
+            MultiLogger.error('Please fix config.yml.')
+            MultiLogger.error(":#{base.keys.map(&:symbol)
             .join(' => :')} => :#{key} should be #{param_types.join(' OR ')}.")
-          exit 1
-        end
+            exit 1
+          end
       end
 
       def config_index

data/lib/fusuma/plugin/buffers/buffer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../base.rb'
+require_relative '../base'
 
 module Fusuma
   module Plugin
@@ -8,6 +8,7 @@ module Fusuma
       # buffer events and output
       class Buffer < Base
         def initialize(*args)
+          super()
           @events = Array.new(*args)
         end
 
@@ -15,7 +16,7 @@ module Fusuma
 
         # @return [String]
         def type
-          self.class.name.underscore.split('/').last.gsub('_buffer', '')
+          @type ||= self.class.name.underscore.split('/').last.gsub('_buffer', '')
         end
 
         # @param event [Event]

data/lib/fusuma/plugin/buffers/gesture_buffer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './buffer.rb'
+require_relative './buffer'
 
 module Fusuma
   module Plugin
@@ -8,17 +8,17 @@ module Fusuma
       # manage events and generate command
       class GestureBuffer < Buffer
         DEFAULT_SOURCE = 'libinput_gesture_parser'
-        DEFAULT_SECONDS_TO_KEEP = 0.1
+        DEFAULT_SECONDS_TO_KEEP = 100
 
         def config_param_types
           {
-            'source': [String],
-            'seconds_to_keep': [Float, Integer]
+            source: [String],
+            seconds_to_keep: [Float, Integer]
           }
         end
 
         # @param event [Event]
-        # @return [Buffer, false]
+        # @return [Buffer, FalseClass]
         def buffer(event)
           # TODO: buffering events into buffer plugins
           # - gesture event buffer
@@ -26,16 +26,13 @@ module Fusuma
           # - other event buffer
           return if event&.tag != source
 
-          if bufferable?(event)
-            @events.push(event)
-            self
-          else
-            clear
-            false
-          end
+          @events.push(event)
+          self
         end
 
         def clear_expired(current_time: Time.now)
+          clear if ended?
+
           @seconds_to_keep ||= (config_params(:seconds_to_keep) || DEFAULT_SECONDS_TO_KEEP)
           @events.each do |e|
             break if current_time - e.time < @seconds_to_keep
@@ -46,17 +43,28 @@ module Fusuma
           end
         end
 
+        def ended?
+          return false if empty?
+
+          @events.last.record.status == 'end'
+        end
+
         # @param attr [Symbol]
         # @return [Float]
         def sum_attrs(attr)
-          @events.map { |gesture_event| gesture_event.record.direction[attr].to_f }
-                 .inject(:+)
+          updating_events.map do |gesture_event|
+            gesture_event.record.delta[attr].to_f
+          end.inject(:+)
+        end
+
+        def updating_events
+          @events.select { |e| e.record.status == 'update' }
         end
 
         # @param attr [Symbol]
         # @return [Float]
         def avg_attrs(attr)
-          sum_attrs(attr).to_f / @events.length
+          sum_attrs(attr).to_f / updating_events.length
         end
 
         # return [Integer]
@@ -76,20 +84,21 @@ module Fusuma
           @events.empty?
         end
 
-        def select_by_events
-          return enum_for(:select) unless block_given?
+        def select_by_events(&block)
+          return enum_for(:select_by_events) unless block_given?
 
-          events = @events.select { |event| yield event }
+          events = @events.select(&block)
           self.class.new events
         end
 
-        def bufferable?(event)
-          case event.record.status
-          when 'begin', 'end'
-            false
-          else
-            true
-          end
+        def select_from_last_begin
+          return self if empty?
+
+          index_from_last = @events.reverse.find_index { |e| e.record.status == 'begin' }
+          return GestureBuffer.new([]) if index_from_last.nil?
+
+          index_last_begin = events.length - index_from_last - 1
+          GestureBuffer.new(@events[index_last_begin..-1])
         end
       end
     end