fusuma-plugin-appmatcher 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d880ea1522a6b2f2aa67f9b687f9622d1fe637fc5cbbfef15b09ee0037018ac5
-  data.tar.gz: 3c74b91209532a87caeeabcdde66c553db2132fd40cd35c4f3d36016b07f8240
+  metadata.gz: e0c42244829fcbe2bd37eb9ebd5241a7208e5702ebfb871645cf0e0d1adba774
+  data.tar.gz: 32b934f58a8cda27708778be32f6e48f68b35cb0cae05fadbbfcd3d61459b8a6
 SHA512:
-  metadata.gz: 1d182d0ddf35c38dd989ffef4572aa31c0cb94d14f7790d8be4b4aeeaddfed55ad1dd0174f08d4dd38183d6aec78501eb2689077db4b5eb782552db8a501cdc0
-  data.tar.gz: 2c834a9e51cfa8b4a14f9cd1482fb9d013b5691df446f22b48ffd68744c88839029e028b1f8aef1bb19c4648301a23e22f3d6955d6ad3b5faae1cc5b47cfa473
+  metadata.gz: cb40f74760a51e78d3672bec9415ee6235de95f74961cb42e64d4492290bc301a2211ab8d5a949b5bb2720a1516d496cc201a0df8e0a781873ef695e0876ce9d
+  data.tar.gz: ebee86ec5a87c274ca3967986ee68188c0dff7c22eb52b5a859fbf1026bd6be16eb5ab0b750e8045cf83b09a125495978c78ea1f795ec9dfe904330cc7b722c1

data/README.md

@@ -1,4 +1,4 @@
-# Fusuma::Plugin::Appmatcher [![Gem Version](https://badge.fury.io/rb/fusuma-plugin-appmatcher.svg)](https://badge.fury.io/rb/fusuma-plugin-appmatcher) [![Build Status](https://github.com/iberianpig/fusuma/actions/workflows/ubuntu.yml/badge.svg)](https://github.com/iberianpig/fusuma-plugin-appmatcher/actions/workflows/ubuntu.yml)
+# Fusuma::Plugin::Appmatcher [![Gem Version](https://badge.fury.io/rb/fusuma-plugin-appmatcher.svg)](https://badge.fury.io/rb/fusuma-plugin-appmatcher) [![Build Status](https://github.com/iberianpig/fusuma/actions/workflows/main.yml/badge.svg)](https://github.com/iberianpig/fusuma-plugin-appmatcher/actions/workflows/main.yml)
 
 [Fusuma](https://github.com/iberianpig/fusuma) plugin configure app-specific gestures
 

data/exe/fusuma-appmatcher

@@ -1,46 +1,45 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'optparse'
-require_relative '../lib/fusuma/plugin/appmatcher.rb'
+require "optparse"
+require_relative "../lib/fusuma/plugin/appmatcher"
 
 option = {}
 opt = OptionParser.new
 
-opt.on('-l', '--list-applications',
-       'List applications') do |v|
+opt.on("-l", "--list-applications",
+  "List applications") do |v|
   option[:list] = v
 end
 
-opt.on('--version', 'Show version') do |v|
+opt.on("--version", "Show version") do |v|
   option[:version] = v
 end
 
-opt.on('--install-gnome-extension',
-       'Install GNOME extension for appmatcher') do |v|
+opt.on("--install-gnome-extension",
+  "Install GNOME extension for appmatcher") do |v|
   option[:install_gnome_extension] = v
 end
 
-opt.on('--uninstall-gnome-extension',
-       'Uninstall GNOME extension for appmatcher') do |v|
+opt.on("--uninstall-gnome-extension",
+  "Uninstall GNOME extension for appmatcher") do |v|
   option[:uninstall_gnome_extension] = v
 end
 
 opt.parse!(ARGV)
 
 if option[:install_gnome_extension]
-  require_relative '../lib/fusuma/plugin/appmatcher/gnome_extensions/installer.rb'
+  require_relative "../lib/fusuma/plugin/appmatcher/gnome_extensions/installer"
   Fusuma::Plugin::Appmatcher::GnomeExtensions::Installer.new.install
   return
 end
 
 if option[:uninstall_gnome_extension]
-  require_relative '../lib/fusuma/plugin/appmatcher/gnome_extensions/installer.rb'
+  require_relative "../lib/fusuma/plugin/appmatcher/gnome_extensions/installer"
   Fusuma::Plugin::Appmatcher::GnomeExtensions::Installer.new.uninstall
   return
 end
 
-
 if option[:list]
   matcher = Fusuma::Plugin::Appmatcher.backend_klass::Matcher.new
   puts matcher.running_applications
@@ -49,6 +48,9 @@ end
 
 if option[:version]
   puts Fusuma::Plugin::Appmatcher::VERSION
+  puts "XDG_CURRENT_DESKTOP: #{ENV.fetch("XDG_CURRENT_DESKTOP", nil)}"
+  puts "XDG_SESSION_TYPE: #{ENV.fetch("XDG_SESSION_TYPE", nil)}"
+  puts "Backend: #{Fusuma::Plugin::Appmatcher.backend_klass}"
   return
 end
 

data/fusuma-plugin-appmatcher.gemspec

@@ -5,27 +5,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "fusuma/plugin/appmatcher/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "fusuma-plugin-appmatcher"
-  spec.version       = Fusuma::Plugin::Appmatcher::VERSION
-  spec.authors       = ["iberianpig"]
-  spec.email         = ["yhkyky@gmail.com"]
+  spec.name = "fusuma-plugin-appmatcher"
+  spec.version = Fusuma::Plugin::Appmatcher::VERSION
+  spec.authors = ["iberianpig"]
+  spec.email = ["yhkyky@gmail.com"]
 
-  spec.summary       = "Fusuma plugin to assign gesture mapping per application"
-  spec.description   = "fusuma-plugin-appmatcher is Fusuma plugin for assigning gesture mapping per application."
-  spec.homepage      = "https://github.com/iberianpig/fusuma-plugin-appmatcher"
-  spec.license       = "MIT"
+  spec.summary = "Fusuma plugin to assign gesture mapping per application"
+  spec.description = "fusuma-plugin-appmatcher is Fusuma plugin for assigning gesture mapping per application."
+  spec.homepage = "https://github.com/iberianpig/fusuma-plugin-appmatcher"
+  spec.license = "MIT"
 
   # Specify which files should be added to the gem when it is released.
-  spec.files          = Dir["{bin,lib,exe}/**/*", "LICENSE*", "README*", "*.gemspec"]
-  spec.test_files     = Dir["{test,spec,features}/**/*"]
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files = Dir["{bin,lib,exe}/**/*", "LICENSE*", "README*", "*.gemspec"]
+  spec.test_files = Dir["{test,spec,features}/**/*"]
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rexml" # ruby-dbus doesn't resolve dependency
   spec.add_runtime_dependency "ruby-dbus"
 
-  spec.add_dependency "fusuma", "~> 2.4"
+  spec.add_dependency "fusuma", ">= 3.0"
   spec.metadata["rubygems_mfa_required"] = "true"
 
   spec.required_ruby_version = ">= 2.5.1" # https://packages.ubuntu.com/search?keywords=ruby&searchon=names&exact=1&suite=all&section=main

data/lib/fusuma/plugin/appmatcher/gnome.rb

@@ -9,7 +9,9 @@ module Fusuma
     module Appmatcher
       # Search Active Window's Name
       class Gnome
-        attr_reader :matcher, :reader, :writer
+        include UserSwitcher
+
+        attr_reader :reader, :writer
 
         def initialize
           @reader, @writer = IO.pipe
@@ -19,12 +21,11 @@ module Fusuma
         # @return [Integer] Process id
         def watch_start
           @watch_start ||= begin
-            pid = UserSwitcher.new.as_user(proctitle: self.class.name.underscore) do |user|
+            pid = as_user(proctitle: self.class.name.underscore) do |user|
               @reader.close
               ENV["DBUS_SESSION_BUS_ADDRESS"] = "unix:path=/run/user/#{user.uid}/bus"
               register_on_application_changed(Matcher.new)
             end
-            Process.detach(pid)
             pid
           end
         end
@@ -41,7 +42,7 @@ module Fusuma
           @writer.puts(name)
         rescue Errno::EPIPE
           exit 0
-        rescue StandardError => e
+        rescue => e
           MultiLogger.error e.message
           exit 1
         end
@@ -101,7 +102,7 @@ module Fusuma
             if success
               response = begin
                 JSON.parse(body)
-              rescue StandardError
+              rescue
                 nil
               end
               return response

data/lib/fusuma/plugin/appmatcher/gnome_extension.rb

@@ -9,7 +9,9 @@ module Fusuma
     module Appmatcher
       # Search Active Window's Name
       class GnomeExtension
-        attr_reader :matcher, :reader, :writer
+        include UserSwitcher
+
+        attr_reader :reader, :writer
 
         def initialize
           @reader, @writer = IO.pipe
@@ -19,12 +21,11 @@ module Fusuma
         # @return [Integer] Process id
         def watch_start
           @watch_start ||= begin
-            pid = UserSwitcher.new.as_user(proctitle: self.class.name.underscore) do |user|
+            pid = as_user(proctitle: self.class.name.underscore) do |user|
               @reader.close
               ENV["DBUS_SESSION_BUS_ADDRESS"] = "unix:path=/run/user/#{user.uid}/bus"
               register_on_application_changed(Matcher.new)
             end
-            Process.detach(pid)
             pid
           end
         end
@@ -47,7 +48,7 @@ module Fusuma
           @writer.puts(name)
         rescue Errno::EPIPE
           exit 0
-        rescue StandardError => e
+        rescue => e
           MultiLogger.error e.message
           exit 1
         end

data/lib/fusuma/plugin/appmatcher/gnome_extensions/installer.rb

@@ -9,10 +9,12 @@ module Fusuma
       module GnomeExtensions
         # Install Gnome Extension
         class Installer
+          include UserSwitcher
+
           EXTENSION = "./appmatcher@iberianpig.dev"
 
           def install
-            pid = UserSwitcher.new.as_user(proctitle: self.class.name.underscore) do |user|
+            pid = as_user(proctitle: self.class.name.underscore) do |user|
               FileUtils.cp_r(source_path, user_extension_dir(user.username))
               puts "Installed Appmatcher Gnome Shell Extension to #{user_extension_dir(user.username)}"
               puts "Restart your session, then activate Appmatcher on gnome-extensions-app"
@@ -23,7 +25,7 @@ module Fusuma
           def uninstall
             return puts "Appmatcher Gnome Shell Extension is not installed in #{user_extension_dir}/" unless installed?
 
-            pid = UserSwitcher.new.as_user(proctitle: self.class.name.underscore) do |user|
+            pid = as_user(proctitle: self.class.name.underscore) do |user|
               FileUtils.rm_r(install_path(user.username))
               puts "Uninstalled Appmatcher Gnome Shell Extension from #{install_path(user.username)}"
             end
@@ -49,7 +51,7 @@ module Fusuma
           end
 
           def login_username
-            UserSwitcher.new.login_user.username
+            UserSwitcher.login_user.username
           end
         end
       end

data/lib/fusuma/plugin/appmatcher/unsupported_backend.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "open3"
+require_relative "./user_switcher"
+require "fusuma/multi_logger"
+require "fusuma/custom_process"
+
+module Fusuma
+  module Plugin
+    module Appmatcher
+      # Dummy for unsupported Backend
+      class UnsupportedBackend
+        include UserSwitcher
+
+        attr_reader :reader, :writer
+
+        def initialize
+          # need IO object for IO.select()
+          @reader, @writer = IO.pipe
+        end
+
+        # fork process and watch signal
+        # @return [Integer] Process id
+        def watch_start
+          @watch_start ||= begin
+            pid = as_user(proctitle: self.class.name.underscore) do
+              @reader.close
+              sleep # stop indefinitely without using CPU
+            end
+            pid
+          end
+        end
+
+        class Matcher
+          def initialize
+          end
+
+          def running_applications
+            warn
+            nil
+          end
+
+          def active_application
+            warn
+            nil
+          end
+
+          private
+
+          def warn
+            MultiLogger.warn(
+              <<~MSG
+                appmatcher doesn't support
+                XDG_CURRENT_DESKTOP: '#{Appmatcher.xdg_current_desktop}'
+                XDG_SESSION_TYPE: '#{Appmatcher.xdg_session_type}'
+
+                using dummy backend instead
+              MSG
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fusuma/plugin/appmatcher/user_switcher.rb

@@ -7,18 +7,8 @@ module Fusuma
   module Plugin
     module Appmatcher
       # Drop sudo privileges
-      class UserSwitcher
+      module UserSwitcher
         include CustomProcess
-        User = Struct.new(:username, :uid, :gid)
-
-        attr_reader :login_user
-
-        def initialize
-          username = ENV["SUDO_USER"] || Etc.getlogin
-          uid = `id -u #{username}`.chomp.to_i
-          gid = `id -g #{username}`.chomp.to_i
-          @login_user = User.new(username, uid, gid)
-        end
 
         # Drops privileges to that of the specified user
         def drop_priv(user)
@@ -30,7 +20,7 @@ module Fusuma
 
         # Execute the provided block in a child process as the specified user
         # The parent blocks until the child finishes.
-        def as_user(user = @login_user, proctitle:)
+        def as_user(user = login_user, proctitle:)
           self.proctitle = "#{self.class.name.underscore}(#{user.username}) -> #{proctitle}"
 
           fork do
@@ -38,6 +28,17 @@ module Fusuma
             yield(user) if block_given?
           end
         end
+
+        User = Struct.new(:username, :uid, :gid)
+        def login_user
+          @login_user ||= begin
+            username = ENV["SUDO_USER"] || Etc.getlogin
+            uid = `id -u #{username}`.chomp.to_i
+            gid = `id -g #{username}`.chomp.to_i
+            User.new(username, uid, gid)
+          end
+        end
+        module_function :login_user
       end
     end
   end

data/lib/fusuma/plugin/appmatcher/version.rb

@@ -3,7 +3,7 @@
 module Fusuma
   module Plugin
     module Appmatcher
-      VERSION = "0.4.0"
+      VERSION = "0.5.0"
     end
   end
 end

data/lib/fusuma/plugin/appmatcher/x11.rb

@@ -10,7 +10,9 @@ module Fusuma
     module Appmatcher
       # Search Active Window's Name
       class X11
-        attr_reader :matcher, :reader, :writer
+        include UserSwitcher
+
+        attr_reader :reader, :writer
 
         def initialize
           @reader, @writer = IO.pipe
@@ -20,11 +22,10 @@ module Fusuma
         # @return [Integer] Process id
         def watch_start
           @watch_start ||= begin
-            pid = UserSwitcher.new.as_user(proctitle: self.class.name.underscore) do |_user|
+            pid = as_user(proctitle: self.class.name.underscore) do |_user|
               @reader.close
               register_on_application_changed(Matcher.new)
             end
-            Process.detach(pid)
             pid
           end
         end
@@ -41,7 +42,7 @@ module Fusuma
           @writer.puts(name)
         rescue Errno::EPIPE
           exit 0
-        rescue StandardError => e
+        rescue => e
           MultiLogger.error e.message
           exit 1
         end
@@ -51,8 +52,8 @@ module Fusuma
           # @return [Array<String>]
           def running_applications
             `xprop -root _NET_CLIENT_LIST_STACKING`.split(", ")
-                                                   .map { |id_str| id_str.match(/0x[\da-z]{2,}/).to_s }
-                                                   .map { |id| active_application(id) }
+              .map { |id_str| id_str.match(/0x[\da-z]{2,}/).to_s }
+              .map { |id| active_application(id) }
           end
 
           # @return [String]
@@ -60,10 +61,10 @@ module Fusuma
           def active_application(id = active_window_id)
             @cache ||= {}
             @cache[id] ||= if id.nil?
-                             nil
-                           else
-                             `xprop -id #{id} WM_CLASS | cut -d "=" -f 2 | tr -d '"'`.strip.split(", ").last
-                           end
+              nil
+            else
+              `xprop -id #{id} WM_CLASS | cut -d "=" -f 2 | tr -d '"'`.strip.split(", ").last
+            end
           end
 
           def on_active_application_changed
@@ -80,7 +81,7 @@ module Fusuma
             o.each do |line|
               id = line.match(/0x[\da-z]{2,}/)&.to_s
 
-              return id unless block_given?
+              return id unless block
 
               yield(id)
             end
@@ -88,11 +89,11 @@ module Fusuma
             e.close
             o.close
 
-            return nil unless block_given?
+            return nil unless block
 
             sleep 0.5
             active_window_id(watch: watch, &block)
-          rescue StandardError => e
+          rescue => e
             MultiLogger.error e.message
           end
 

data/lib/fusuma/plugin/appmatcher.rb

@@ -2,10 +2,11 @@
 
 require "fusuma/plugin/appmatcher/version"
 
-require_relative "appmatcher/x11"
-require_relative "appmatcher/gnome"
-require_relative "appmatcher/gnome_extension"
-require_relative "appmatcher/gnome_extensions/installer"
+require "fusuma/plugin/appmatcher/x11"
+require "fusuma/plugin/appmatcher/gnome"
+require "fusuma/plugin/appmatcher/gnome_extension"
+require "fusuma/plugin/appmatcher/gnome_extensions/installer"
+require "fusuma/plugin/appmatcher/unsupported_backend"
 
 module Fusuma
   module Plugin
@@ -27,8 +28,7 @@ module Fusuma
           end
         end
 
-        error_message_not_supported
-        exit 1
+        UnsupportedBackend
       end
 
       def xdg_session_type
@@ -38,16 +38,6 @@ module Fusuma
       def xdg_current_desktop
         ENV.fetch("XDG_CURRENT_DESKTOP", "")
       end
-
-      def error_message_not_supported
-        MultiLogger.error(
-          <<~ERROR
-            appmatcher doesn't support
-            XDG_CURRENT_DESKTOP: '#{xdg_current_desktop}'
-            XDG_SESSION_TYPE: '#{xdg_session_type}'"
-          ERROR
-        )
-      end
     end
   end
 end

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

@@ -5,7 +5,7 @@ module Fusuma
     module Buffers
       # Buffer events having KeypressRecord
       class AppmatcherBuffer < Buffer
-        DEFAULT_SOURCE = "appmatcher_parser"
+        DEFAULT_SOURCE = "appmatcher_input"
 
         # @param event [Event]
         def buffer(event)

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

@@ -22,6 +22,22 @@ module Fusuma
 
           @backend.reader
         end
+
+        def shutdown
+          # CustomProcess#shutdown
+          @backend.shutdown
+        end
+
+        # @param record [String] application name
+        # @return [Event]
+        def create_event(record:)
+          e = Events::Event.new(
+            tag: tag,
+            record: Events::Records::AppmatcherRecord.new(name: record)
+          )
+          MultiLogger.debug(input_event: e)
+          e
+        end
       end
     end
   end

data/spec/fusuma/plugin/appmatcher_spec.rb

@@ -42,7 +42,7 @@ module Fusuma
               allow(Appmatcher).to receive(:xdg_current_desktop).and_return("UNKNOWN")
               allow(MultiLogger).to receive(:error)
             end
-            it { expect { subject }.to raise_error(SystemExit) }
+            it { is_expected.to eq Appmatcher::UnsupportedBackend }
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma-plugin-appmatcher
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - iberianpig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-30 00:00:00.000000000 Z
+date: 2023-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rexml
@@ -42,16 +42,16 @@ dependencies:
   name: fusuma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '3.0'
 description: fusuma-plugin-appmatcher is Fusuma plugin for assigning gesture mapping
   per application.
 email:
@@ -73,6 +73,7 @@ files:
 - lib/fusuma/plugin/appmatcher/gnome_extensions/appmatcher@iberianpig.dev/extension.js
 - lib/fusuma/plugin/appmatcher/gnome_extensions/appmatcher@iberianpig.dev/metadata.json
 - lib/fusuma/plugin/appmatcher/gnome_extensions/installer.rb
+- lib/fusuma/plugin/appmatcher/unsupported_backend.rb
 - lib/fusuma/plugin/appmatcher/user_switcher.rb
 - lib/fusuma/plugin/appmatcher/version.rb
 - lib/fusuma/plugin/appmatcher/x11.rb
@@ -80,7 +81,6 @@ files:
 - lib/fusuma/plugin/detectors/appmatcher_detector.rb
 - lib/fusuma/plugin/events/records/appmatcher_record.rb
 - lib/fusuma/plugin/inputs/appmatcher_input.rb
-- lib/fusuma/plugin/parsers/appmatcher_parser.rb
 - spec/fusuma/plugin/appmatcher/gnome_extensions/installer_spec.rb
 - spec/fusuma/plugin/appmatcher/gnome_spec.rb
 - spec/fusuma/plugin/appmatcher_spec.rb
@@ -106,13 +106,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Fusuma plugin to assign gesture mapping per application
 test_files:
-- spec/fusuma/plugin/appmatcher_spec.rb
 - spec/fusuma/plugin/appmatcher/gnome_extensions/installer_spec.rb
 - spec/fusuma/plugin/appmatcher/gnome_spec.rb
+- spec/fusuma/plugin/appmatcher_spec.rb
 - spec/fusuma/plugin/detectors/appmatcher_detector_spec.rb
 - spec/spec_helper.rb

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

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Fusuma
-  module Plugin
-    module Parsers
-      # Generate AppmatcherRecord from libinput_command_input
-      class AppmatcherParser < Parser
-        DEFAULT_SOURCE = "appmatcher_input"
-
-        # @param record [String]
-        # @return [Records::Gesture, nil]
-        def parse_record(record)
-          line = record.to_s
-          Events::Records::AppmatcherRecord.new(name: line)
-        end
-      end
-    end
-  end
-end