fusuma 1.9.0 → 2.0.0.pre

data/bin/console

@@ -8,5 +8,20 @@ require 'fusuma'
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
+
+def reload!(print = true)
+  puts 'Reloading ...' if print
+  # Main project directory.
+  root_dir = File.expand_path('..', __dir__)
+  # Directories within the project that should be reloaded.
+  reload_dirs = %w[lib]
+  # Loop through and reload every file in all relevant project directories.
+  reload_dirs.each do |dir|
+    Dir.glob("#{root_dir}/#{dir}/**/*.rb").each { |f| load(f) }
+  end
+  # Return true when complete.
+  true
+end
+
 require 'pry'
 Pry.start

data/fusuma.gemspec

@@ -24,15 +24,5 @@ Gem::Specification.new do |spec|
   spec.metadata['yard.run'] = 'yri' # use "yard" to build full HTML docs.
 
   spec.required_ruby_version = '>= 2.3' # https://packages.ubuntu.com/search?keywords=ruby&searchon=names&exact=1&suite=all&section=main
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency "coveralls"
-  spec.add_development_dependency 'github_changelog_generator', '~> 1.14'
-  spec.add_development_dependency 'pry-byebug', '~> 3.4'
-  spec.add_development_dependency 'pry-doc'
-  spec.add_development_dependency 'pry-inline'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'reek'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'yard'
+  spec.add_dependency 'posix-spawn'
 end

data/lib/fusuma.rb

@@ -4,6 +4,7 @@ require_relative './fusuma/version'
 require_relative './fusuma/multi_logger'
 require_relative './fusuma/config.rb'
 require_relative './fusuma/environment.rb'
+require_relative './fusuma/device.rb'
 require_relative './fusuma/plugin/manager.rb'
 
 # this is top level module
@@ -47,8 +48,6 @@ module Fusuma
       end
 
       def load_custom_config(config_path = nil)
-        return unless config_path
-
         Config.custom_path = config_path
       end
     end
@@ -63,8 +62,9 @@ module Fusuma
     end
 
     def run
-      # TODO: run with multi thread
-      @inputs.first.run do |event|
+      loop do
+        event = input
+        event || next
         clear_expired_events
         filtered = filter(event) || next
         parsed = parse(filtered) || next
@@ -75,6 +75,10 @@ module Fusuma
       end
     end
 
+    def input
+      Plugin::Inputs::Input.select(@inputs)
+    end
+
     def filter(event)
       event if @filters.any? { |f| f.filter(event) }
     end
@@ -111,11 +115,15 @@ module Fusuma
     def execute(event)
       return unless event
 
-      executor = @executors.find do |e|
-        e.executable?(event)
+      l = lambda do
+        executor = @executors.find { |e| e.executable?(event) }
+        executor&.execute(event)
       end
 
-      executor&.execute(event)
+      l.call ||
+        Config::Searcher.skip { l.call } ||
+        Config::Searcher.fallback { l.call } ||
+        Config::Searcher.skip { Config::Searcher.fallback { l.call } }
     end
 
     def clear_expired_events

data/lib/fusuma/config.rb

@@ -2,6 +2,8 @@
 
 require_relative './multi_logger.rb'
 require_relative './config/index.rb'
+require_relative './config/searcher.rb'
+require_relative './config/yaml_duplication_checker.rb'
 require 'singleton'
 require 'yaml'
 
@@ -9,6 +11,9 @@ require 'yaml'
 module Fusuma
   # read keymap from yaml file
   class Config
+    class NotFoundError < StandardError; end
+    class InvalidFileError < StandardError; end
+
     include Singleton
 
     class << self
@@ -23,12 +28,12 @@ module Fusuma
 
     attr_reader :keymap
     attr_reader :custom_path
+    attr_reader :searcher
 
     def initialize
+      @searcher = Searcher.new
       @custom_path = nil
-      @cache = nil
       @keymap = nil
-      reload
     end
 
     def custom_path=(new_path)
@@ -37,40 +42,51 @@ module Fusuma
     end
 
     def reload
-      @cache  = nil
-      @keymap = YAML.load_file(file_path).deep_symbolize_keys
-      MultiLogger.info "reload config : #{file_path}"
+      @searcher = Searcher.new
+      path = find_filepath
+      MultiLogger.info "reload config: #{path}"
+      @keymap = validate(path)
       self
     end
 
-    # @param index [Index]
-    def search(index)
-      cache(index.cache_key) do
-        index.keys.reduce(keymap) do |location, key|
-          if location.is_a?(Hash)
-            begin
-              if key.skippable
-                location.fetch(key.symbol, location)
-              else
-                location.fetch(key.symbol, nil)
-              end
-            end
-          else
-            location
-          end
-        end
+    # @return [Hash]
+    # @raise [InvalidError]
+    def validate(path)
+      duplicates = []
+      YAMLDuplicationChecker.check(File.read(path), path) do |ignored, duplicate|
+        MultiLogger.error "#{path}: #{ignored.value} is duplicated"
+        duplicates << duplicate.value
       end
+      raise InvalidFileError, "Detect duplicate keys #{duplicates}" unless duplicates.empty?
+
+      yaml = YAML.load_file(path)
+
+      raise InvalidFileError, 'Invaid YAML file' unless yaml.is_a? Hash
+
+      yaml.deep_symbolize_keys
+    rescue StandardError => e
+      MultiLogger.error e.message
+      raise InvalidFileError, e.message
+    end
+
+    # @param index [Index]
+    # @param location [Hash]
+    def search(index, location: keymap)
+      @searcher.search_with_cache(index, location: location)
     end
 
     private
 
-    def file_path
+    def find_filepath
       filename = 'fusuma/config.yml'
-      if custom_path && File.exist?(expand_custom_path)
-        expand_custom_path
+      if custom_path
+        return expand_custom_path if File.exist?(expand_custom_path)
+
+        raise NotFoundError, "#{expand_custom_path} is NOT FOUND"
       elsif File.exist?(expand_config_path(filename))
         expand_config_path(filename)
       else
+        MultiLogger.warn "config file: #{expand_config_path(filename)} is NOT FOUND"
         expand_default_path(filename)
       end
     end
@@ -86,16 +102,6 @@ module Fusuma
     def expand_default_path(filename)
       File.expand_path "../../#{filename}", __FILE__
     end
-
-    def cache(key)
-      @cache ||= {}
-      key = key.join(',') if key.is_a? Array
-      if @cache.key?(key)
-        @cache[key]
-      else
-        @cache[key] = block_given? ? yield : nil
-      end
-    end
   end
 end
 

data/lib/fusuma/config/index.rb

@@ -34,15 +34,22 @@ module Fusuma
 
       # Keys in Index
       class Key
-        def initialize(symbol_word, skippable: false)
+        def initialize(symbol_word, skippable: false, fallback: nil)
           @symbol = begin
                       symbol_word.to_sym
                     rescue StandardError
                       symbol_word
                     end
+
           @skippable = skippable
+
+          @fallback = begin
+                        fallback.to_sym
+                      rescue StandardError
+                        fallback
+                      end
         end
-        attr_reader :symbol, :skippable
+        attr_reader :symbol, :skippable, :fallback
       end
     end
   end

data/lib/fusuma/config/searcher.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+# Index for searching value from config.yml
+module Fusuma
+  class Config
+    # Search config.yml
+    class Searcher
+      def initialize
+        @cache
+      end
+
+      # @param index [Index]
+      # @param location [Hash]
+      # @return [NilClass]
+      # @return [Hash]
+      # @return [Object]
+      def search(index, location:)
+        key = index.keys.first
+        return location if key.nil?
+
+        return nil if location.nil?
+
+        return nil unless location.is_a?(Hash)
+
+        next_index = Index.new(index.keys[1..-1])
+
+        value = nil
+        next_location_cadidates(location, key).find do |next_location|
+          value = search(next_index, location: next_location)
+        end
+        value
+      end
+
+      def search_with_cache(index, location:)
+        cache([index.cache_key, Searcher.skip?, Searcher.fallback?]) do
+          search(index, location: location)
+        end
+      end
+
+      def cache(key)
+        @cache ||= {}
+        key = key.join(',') if key.is_a? Array
+        if @cache.key?(key)
+          @cache[key]
+        else
+          @cache[key] = block_given? ? yield : nil
+        end
+      end
+
+      private
+
+      # next locations' candidates sorted by priority
+      #  1. look up location with key
+      #  2. fallback to other key
+      #  3. skip the key and go to child location
+      def next_location_cadidates(location, key)
+        [
+          location[key.symbol],
+          Searcher.fallback? && key.fallback && location[key.fallback],
+          Searcher.skip? && key.skippable && location
+        ].compact
+      end
+
+      class << self
+        def fallback?
+          @fallback
+        end
+
+        def skip?
+          @skip
+        end
+
+        # switch context for fallback
+        def fallback(&block)
+          @fallback = true
+          result = block.call
+          @fallback = false
+          result
+        end
+
+        def skip(&block)
+          @skip = true
+          result = block.call
+          @skip = false
+          result
+        end
+      end
+    end
+  end
+end

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/device.rb

@@ -59,7 +59,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

data/lib/fusuma/environment.rb

@@ -17,8 +17,9 @@ 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 "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/libinput_command.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
-require 'open3'
+require 'posix/spawn'
 
 module Fusuma
   # Execute libinput command
   class LibinputCommand
-    def initialize(libinput_options: [])
+    def initialize(libinput_options: [], commands: {})
+      @debug_events_command = commands[:debug_events_command]
+      @list_devices_command = commands[:list_devices_command]
       @libinput_options = libinput_options
     end
 
@@ -13,6 +15,9 @@ module Fusuma
     # use `libinput list-devices` and `libinput debug-events` from 1.8.
     NEW_CLI_OPTION_VERSION = 1.8
 
+    DEFAULT_WAIT_TIME = 0.3
+    TIMEOUT_MESSAGE = 'LIBINPUT TIMEOUT'
+
     # @return [Boolean]
     def new_cli_option_available?
       Gem::Version.new(version) >= Gem::Version.new(NEW_CLI_OPTION_VERSION)
@@ -28,27 +33,29 @@ module Fusuma
     def list_devices
       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 { |line| yield(line) }
+    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 [String] return a latest line libinput debug-events
     def debug_events
-      prefix = 'stdbuf -oL --'
-      cmd = "#{prefix} #{debug_events_command} #{@libinput_options.join(' ')}".strip
-      MultiLogger.debug(debug_events: cmd)
-      Open3.popen3(cmd) do |_i, o, _e, _w|
-        o.each do |line|
-          yield(line.chomp)
-        end
-      end
+      @debug_events ||= begin
+                          _p, i, o, _e = POSIX::Spawn.popen4(debug_events_with_options)
+                          i.close
+                          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'
@@ -59,7 +66,9 @@ module Fusuma
     end
 
     def list_devices_command
-      if new_cli_option_available?
+      if @list_devices_command
+        @list_devices_command
+      elsif new_cli_option_available?
         'libinput list-devices'
       else
         'libinput-list-devices'
@@ -67,15 +76,26 @@ module Fusuma
     end
 
     def debug_events_command
-      if new_cli_option_available?
+      if @debug_events_command
+        @debug_events_command
+      elsif new_cli_option_available?
         'libinput debug-events'
       else
         'libinput-debug-events'
       end
     end
 
+    def debug_events_with_options
+      prefix = 'stdbuf -oL --'
+      "#{prefix} #{debug_events_command} #{@libinput_options.join(' ')}".strip
+    end
+
     private
 
+    def wait_time
+      DEFAULT_WAIT_TIME
+    end
+
     # which in ruby: Checking if program exists in $PATH from ruby
     # (https://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby)
     # Cross-platform way of finding an executable in the $PATH.