fusuma 2.0.0.pre → 2.0.3

data/lib/fusuma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fusuma
-  VERSION = '2.0.0.pre'
+  VERSION = '2.0.3'
 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

data/spec/lib/custom_process_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require './lib/fusuma/custom_process'
+
+module Fusuma
+  RSpec.describe CustomProcess do
+    class ForkTest
+      include CustomProcess
+
+      def call
+        fork { puts 'hoge' }
+      end
+    end
+
+    describe '.fork' do
+      before do
+        allow(Process).to receive(:fork)
+      end
+      it 'call Process.fork and Process.setproctitle' do
+        expect(Process).to receive(:fork).and_yield do
+          expect(Process).to receive(:setproctitle)
+        end
+        ForkTest.new.call
+      end
+    end
+  end
+end

data/spec/lib/device_spec.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require './lib/fusuma/device'
+require './lib/fusuma/plugin/inputs/libinput_command_input'
+
+module Fusuma
+  RSpec.describe Device do
+    describe '.all' do
+      it 'should fetch all devices'
+    end
+
+    describe '.reset' do
+      it 'should clear all cache'
+    end
+
+    describe '.available' do
+      let(:libinput_device_command) { 'dummy-libinput-list-devices' }
+
+      before do
+        Device.reset
+        allow_any_instance_of(LibinputCommand)
+          .to receive(:list_devices_command)
+          .and_return(libinput_device_command)
+
+        @dummy_io = StringIO.new('dummy')
+        allow(Open3).to receive(:popen3)
+          .with(libinput_device_command)
+          .and_return([@dummy_io, list_devices_output, @dummy_io, nil])
+      end
+
+      context 'with XPS-9360 (have a correct device)' do
+        let(:list_devices_output) do
+          File.open('./spec/lib/libinput-list-devices_iberianpig-XPS-9360.txt')
+        end
+
+        it { expect(Device.available).to be_a Array }
+        it { expect(Device.available.map(&:name)).not_to include 'Power Button' }
+        it { expect(Device.available.map(&:name)).to include 'DLL075B:01 06CB:76AF Touchpad' }
+      end
+
+      context 'with no tap to click device (like a bluetooth apple trackpad)' do
+        let(:list_devices_output) do
+          File.open('spec/lib/libinput-list-devices_magic_trackpad.txt')
+        end
+
+        it { expect(Device.available).to be_a Array }
+        it { expect(Device.available.map(&:name)).to eq ['Christopher’s Trackpad', 'bcm5974'] }
+      end
+
+      context "context with the device's name not found at first line" do
+        let(:list_devices_output) do
+          File.open('spec/lib/libinput-list-devices_thejinx0r.txt')
+        end
+
+        it { expect(Device.available).to be_a Array }
+        it { expect(Device.available.map(&:name)).to include 'HTX USB HID Device HTX HID Device Touchpad' }
+      end
+
+      context 'when no devices' do
+        let(:list_devices_output) do
+          File.open('spec/lib/libinput-list-devices_unavailable.txt')
+        end
+
+        it 'should failed with exit' do
+          expect { Device.available }.to raise_error(SystemExit)
+        end
+
+        it 'should failed with printing error log' do
+          expect(MultiLogger).to receive(:error)
+          expect { Device.available }.to raise_error(SystemExit)
+        end
+      end
+
+      context 'with some device has same names' do
+        let(:list_devices_output) do
+          File.open('spec/lib/libinput-list-devices_razer_razer_blade.txt')
+        end
+
+        it { expect(Device.available).to be_a Array }
+        it 'should have capabilities' do
+          razer_devices = Device.all.group_by(&:name)['Razer Razer Blade']
+          expect(razer_devices.size).to eq 3
+        end
+
+        it 'should know capabilities' do
+          razer_devices = Device.all.group_by(&:name)['Razer Razer Blade']
+          capabilities = razer_devices.map(&:capabilities)
+          expect(capabilities).to eq ['keyboard', 'keyboard pointer', 'pointer']
+          keyboard_devices = razer_devices.select { |d| d.capabilities == 'keyboard' }
+          expect(keyboard_devices.size).to eq 1
+        end
+      end
+    end
+  end
+end

data/spec/lib/dummy_config.yml

@@ -0,0 +1,31 @@
+swipe:
+  3:
+    left:
+      command: 'echo swipe 3 left'
+    right:
+      command: 'echo swipe 3 right'
+    up:
+      command: 'echo swipe 3 up'
+    down:
+      command: 'echo swipe 3 down'
+  4:
+    left:
+      command: 'echo swipe 4 left'
+    right:
+      command: 'echo swipe 4 right'
+    up:
+      command: 'echo swipe 4 up'
+    down:
+      command: 'echo swipe 4 down'
+
+pinch:
+  2:
+    in:
+      command: 'echo pinch 2 in'
+    out:
+      command: 'echo pinch 2 out'
+  4:
+    in:
+      command: 'echo pinch 4 in'
+    out:
+      command: 'echo pinch 4 in'

data/spec/lib/fusuma_spec.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require './lib/fusuma'
+require './lib/fusuma/plugin/inputs/libinput_command_input'
+require './lib/fusuma/plugin/filters/libinput_device_filter'
+
+module Fusuma
+  RSpec.describe Runner do
+    describe '.run' do
+      before do
+        Singleton.__init__(MultiLogger)
+        Singleton.__init__(Config)
+        allow_any_instance_of(Runner).to receive(:run)
+        allow_any_instance_of(LibinputCommand).to receive(:version)
+          .and_return("1.8\n")
+      end
+
+      context 'when without option' do
+        it 'should not enable debug mode' do
+          expect(MultiLogger.instance).not_to be_debug_mode
+          Runner.run
+        end
+      end
+
+      context 'when run with argument "--version"' do
+        # NOTE: skip print reload config message
+        before { allow(MultiLogger).to receive(:info).with(anything) }
+        it 'should print version' do
+          expect(MultiLogger).to receive(:info)
+            .with("Fusuma: #{Fusuma::VERSION}")
+          expect(MultiLogger).to receive(:info)
+            .with("libinput: #{LibinputCommand.new.version}")
+          expect(MultiLogger).to receive(:info)
+            .with("OS: #{`uname -rsv`}".strip)
+          expect(MultiLogger).to receive(:info)
+            .with("Distribution: #{`cat /etc/issue`}".strip)
+          expect(MultiLogger).to receive(:info)
+            .with("Desktop session: #{`echo $DESKTOP_SESSION $XDG_SESSION_TYPE`}".strip)
+          expect { Runner.run(version: true) }.to raise_error(SystemExit)
+        end
+      end
+
+      context 'when run with argument "-l"' do
+        it 'should print device list' do
+          allow(Device).to receive(:available) {
+            [
+              Device.new(name: 'test_device1'),
+              Device.new(name: 'test_device2')
+            ]
+          }
+
+          expected = <<~OUTPUT
+            test_device1
+            test_device2
+          OUTPUT
+          expect { Runner.run(list: true) }.to raise_error(SystemExit)
+            .and output(/#{expected}/).to_stdout
+        end
+      end
+
+      # TODO: remove from_option and command line options
+      context 'when run with argument "--device="test_device2"' do
+        it 'should set device' do
+          allow(Device).to receive(:names) { %w[test_device1 test_device2] }
+          expect(Plugin::Filters::LibinputDeviceFilter::KeepDevice)
+            .to receive(:from_option=).with('test_device2')
+          Runner.run(device: 'test_device2')
+        end
+      end
+
+      context 'when run with argument "-v"' do
+        it 'should enable debug mode' do
+          MultiLogger.send(:new)
+          Runner.run(verbose: true)
+          expect(MultiLogger.instance).to be_debug_mode
+        end
+      end
+
+      context 'when run with argument "-c path/to/config.yml"' do
+        before do
+          allow_any_instance_of(Runner).to receive(:run)
+          @config = Config.instance
+
+          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 assign custom_path' do
+          expect { Runner.run(config_path: @file_path) }
+            .to change { @config.custom_path }.from(nil).to(@file_path)
+        end
+      end
+    end
+  end
+end