fusuma 1.10.2 → 2.0.1

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_path = File.expand_path('../../../fusuma.gemspec', __dir__)
+          fusuma_gemspec = Gem::Specification.load(fusuma_gemspec_path)
+          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

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../base.rb'
+require_relative '../base'
 
 module Fusuma
   module Plugin
@@ -13,15 +13,14 @@ module Fusuma
         # @param event [Event]
         # @return [Event]
         def parse(event)
-          event.tap do |e|
-            next if e.tag != source
+          return event if event.tag != source
 
-            new_record = parse_record(e.record)
-            next unless new_record
+          new_record = parse_record(event.record)
+          return event if new_record.nil?
 
-            e.record = new_record
-            e.tag = tag
-          end
+          event.record = new_record
+          event.tag = tag
+          event
         end
 
         # Set source for tag from config.yml.
@@ -31,7 +30,7 @@ module Fusuma
         end
 
         def tag
-          self.class.name.split('::').last.underscore
+          @tag ||= self.class.name.split('::').last.underscore
         end
 
         # parse Record object

data/lib/fusuma/string_support.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# support camerize and underscore
+class String
+  def camelize
+    split('_').map(&:capitalize).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/version.rb

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

data/spec/helpers/config_helper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+require './lib/fusuma/config'
+
+module Fusuma
+  module ConfigHelper
+    module_function
+
+    def load_config_yml=(string)
+      Config.custom_path = Tempfile.open do |temp_file|
+        temp_file.tap { |f| f.write(string) }
+      end
+    end
+
+    def clear_config_yml
+      Config.custom_path = nil
+    end
+  end
+end

data/spec/lib/config/searcher_spec.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require './lib/fusuma/config'
+require './lib/fusuma/config/searcher'
+
+# spec for Config
+module Fusuma
+  RSpec.describe Config::Searcher do
+    let(:keymap) do
+      {
+        'swipe' => {
+          3 => {
+            'left' => { 'command' => 'alt+Left' },
+            'right' => { 'command' => 'alt+Right' }
+          },
+          4 => {
+            'left' => { 'command' => 'super+Left' },
+            'right' => { 'command' => 'super+Right' }
+          }
+        },
+        'pinch' => {
+          'in' => { 'command' => 'ctrl+plus' },
+          'out' => { 'command' => 'ctrl+minus' }
+        }
+      }
+    end
+
+    let(:keymap_without_finger) do
+      {
+        'swipe' => {
+          'left' => { 'command' => 'alt+Left' }
+        }
+      }
+    end
+
+    describe '.custom_path=' do
+      before { Singleton.__init__(Config) }
+      it 'should reload keymap file' do
+        keymap = Config.instance.keymap
+        Config.custom_path = './spec/lib/dummy_config.yml'
+        custom_keymap = Config.instance.keymap
+        expect(keymap).not_to eq custom_keymap
+      end
+    end
+
+    describe '.search' do
+      let(:index) { nil }
+      subject { Config::Searcher.new.search(index, location: keymap.deep_symbolize_keys) }
+      context 'index correct order' do
+        let(:index) { Config::Index.new %w[pinch in command] }
+        it { is_expected.to eq 'ctrl+plus' }
+      end
+
+      context 'index include skippable key' do
+        let(:index) do
+          Config::Index.new [
+            Config::Index::Key.new('pinch'),
+            Config::Index::Key.new(2, skippable: true),
+            Config::Index::Key.new('out'),
+            Config::Index::Key.new('command')
+          ]
+        end
+        it { expect(Config::Searcher.skip { subject }).to eq 'ctrl+minus' }
+      end
+
+      context 'index include skippable key at first' do
+        let(:index) do
+          Config::Index.new [
+            Config::Index::Key.new(:hoge, skippable: true),
+            Config::Index::Key.new(:fuga, skippable: true),
+            Config::Index::Key.new('pinch'),
+            Config::Index::Key.new('in'),
+            Config::Index::Key.new(:piyo, skippable: true),
+            Config::Index::Key.new('command')
+          ]
+        end
+        it { expect(Config::Searcher.skip { subject }).to eq 'ctrl+plus' }
+      end
+
+      context 'index incorrect order' do
+        let(:index) { Config::Index.new %w[in pinch 2 command] }
+        it { is_expected.not_to eq 'ctrl+plus' }
+      end
+    end
+
+    describe 'private_method: :cache' do
+      it 'should cache command' do
+        key   = %w[event_type finger direction command].join(',')
+        value = 'shourtcut string'
+        searcher = Config::Searcher.new
+        searcher.send(:cache, key) { value }
+        expect(searcher.send(:cache, key)).to eq value
+      end
+    end
+  end
+end

data/spec/lib/config_spec.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require './lib/fusuma/config'
+
+# spec for Config
+module Fusuma
+  RSpec.describe Config do
+    let(:keymap) do
+      {
+        'swipe' => {
+          3 => {
+            'left' => { 'command' => 'alt+Left' },
+            'right' => { 'command' => 'alt+Right' }
+          },
+          4 => {
+            'left' => { 'command' => 'super+Left' },
+            'right' => { 'command' => 'super+Right' }
+          }
+        },
+        'pinch' => {
+          'in' => { 'command' => 'ctrl+plus' },
+          'out' => { 'command' => 'ctrl+minus' }
+        }
+      }
+    end
+
+    let(:keymap_without_finger) do
+      {
+        'swipe' => {
+          'left' => { 'command' => 'alt+Left' }
+        }
+      }
+    end
+
+    describe '.custom_path=' do
+      before { Singleton.__init__(Config) }
+      it 'should reload keymap file' do
+        keymap = Config.instance.keymap
+        Config.custom_path = './spec/lib/dummy_config.yml'
+        custom_keymap = Config.instance.keymap
+        expect(keymap).not_to eq custom_keymap
+      end
+    end
+
+    describe '#reload' do
+      before { Singleton.__init__(Config) }
+      it 'set Seacher' do
+        old = Config.instance.searcher
+        Config.instance.reload
+        expect(Config.instance.searcher).not_to eq(old)
+      end
+    end
+
+    describe '#validate' do
+      context 'with valid yaml' do
+        before do
+          string = <<~CONFIG
+            swipe:
+              3:
+                left:
+                  command: echo 'swipe left'
+
+          CONFIG
+          @file_path = Tempfile.open do |temp_file|
+            temp_file.tap { |f| f.write(string) }
+          end
+        end
+
+        it 'should return Hash' do
+          Config.instance.validate(@file_path)
+        end
+      end
+
+      context 'with invalid yaml' do
+        before do
+          string = <<~CONFIG
+            this is not yaml
+          CONFIG
+          @file_path = Tempfile.open do |temp_file|
+            temp_file.tap { |f| f.write(string) }
+          end
+        end
+
+        it 'raise InvalidFileError' do
+          expect { Config.instance.validate(@file_path) }.to raise_error(Config::InvalidFileError)
+        end
+
+        context 'with duplicated key' do
+          before do
+            string = <<~CONFIG
+              pinch:
+                2:
+                  in:
+                    command: "xdotool keydown ctrl click 4 keyup ctrl" # threshold: 0.5, interval: 0.5
+                2:
+                  out:
+                    command: "xdotool keydown ctrl click 5 keyup ctrl" # threshold: 0.5, interval: 0.5
+            CONFIG
+            @file_path = Tempfile.open do |temp_file|
+              temp_file.tap { |f| f.write(string) }
+            end
+          end
+
+          it 'raise InvalidFileError' do
+            expect { Config.instance.validate(@file_path) }.to raise_error(Config::InvalidFileError)
+          end
+        end
+      end
+    end
+  end
+end