uh-wm 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 959239c4e633cdfa25d86371729560ddf40afa4a
-  data.tar.gz: 704626fb3cfe89b8ea8d84fe5f6e1200d9000ffa
+SHA256:
+  metadata.gz: bdfaa9044850872fdb32698f87fe8323e5e846519b6c6bec7815db47169ca8d1
+  data.tar.gz: b5fc6c161f4c491d6cf80f32eaa7ea2f494c21bda689424baa3bb7e6ea4628f0
 SHA512:
-  metadata.gz: e2a06d4832cfff8ffdb1ed5bf6c59f999b51c8d6e3f055f449e5414be799fd0c88beaf0b054a0c9054d0930d0bfb5a170fc1b5090966c3f60f90b1a9778de3ff
-  data.tar.gz: 5f96afa7bc57f3ea5e48dc7a8ba8544b9472b29957c06ef0a760a3ba8423c6d0ce26614e2cee2f9e1f70e57aa3253ff724962f2c9b4bfcd8043bda5953442cb7
+  metadata.gz: c36a250861f7afa38a3fef39a72979d71576bfd71083e46e7405d42c4c050fa38f21374b8abbcbac6485c39c5c51bf9a240a5d08d4db073f8e229f496b7c70f0
+  data.tar.gz: fcfe9ec464a7ee86e725bb2fd93c02151d429057764fe987db90ceee1887adcb1aec4770ea3dbc571a9a3ebc86a9e967c4f90dd679b780725c2711795532b896

data/README.md

@@ -7,7 +7,7 @@ directly with ruby code.
 
   The layout behavior can be changed, the default one being
 implemented by the `uh-layout` ruby gem. A layout is a simple ruby
-object responding to specific messages, so you can wrote your own in
+object responding to specific messages, so you can write your own in
 plain ruby without any dependency.
 
   Main features:
@@ -16,7 +16,7 @@ plain ruby without any dependency.
   * different adapters for event handling: blocking, multiplexing
     with `select()` or `kqueue()`;
   * configuration with a run control file;
-  * key bindings with user defined code as callback;
+  * key bindings with user defined callbacks;
   * configurable modifier key;
   * user-defined layout behavior (ruby);
   * external program execution;
@@ -67,8 +67,7 @@ BROWSERS  = %w[
 
 modifier :mod1                # This key is added to the modifier mask for *all*
                               # key bindings.
-key(:p)     { execute DMENU } # Execute given command in a shell when mod1+shift
-                              # is pressed.
+key(:p)     { execute DMENU } # Execute given command in a shell with mod1+p.
 key(:Q)     { quit }          # Quit when mod1+shift+q is pressed (a capitalized
                               # key adds shift to mod mask).
 key(:enter) { execute VT }    # Common key names (`enter') are translated to

data/lib/uh/wm/actions_handler.rb

@@ -68,16 +68,16 @@ module Uh
       end
 
       # Forwards unhandled messages prefixed with `layout_` to the layout,
-      # without the prefix
+      # replacing the prefix with `handle_`
       # @example
-      #   layout_foo # delegates to `layout.foo'
+      #   layout_foo # delegates to `layout.handle_foo'
       def method_missing m, *args, &block
         if respond_to? m
           meth = layout_method m
           log "#{layout.class.name}##{meth} #{args.inspect}"
-          begin
+          if layout.respond_to? meth
             layout.send meth, *args
-          rescue NoMethodError
+          else
             log_error "Layout does not implement `#{meth}'"
           end
         else
@@ -100,7 +100,7 @@ module Uh
     private
 
       def layout_method m
-        m.to_s.gsub(/\Alayout_/, 'handle_').to_sym
+        m.to_s.sub(/\Alayout_/, 'handle_').to_sym
       end
     end
   end

data/lib/uh/wm/cli.rb

@@ -1,90 +1,39 @@
 module Uh
   module WM
-    class CLI
-      ArgumentError = Class.new(ArgumentError)
-
-      include EnvLogging
-
-      USAGE = "Usage: #{File.basename $0} [options]".freeze
-
-      EX_USAGE    = 64
-      EX_SOFTWARE = 70
-
+    class CLI < Baf::CLI
       class << self
-        def run arguments, stdout: $stdout, stderr: $stderr
-          cli = new arguments, stdout: stdout
-          cli.parse_arguments!
-          cli.run
-        rescue ArgumentError => e
-          stderr.puts e
-          exit EX_USAGE
-        rescue RuntimeError => e
-          stderr.puts "#{e.class.name}: #{e.message}"
-          stderr.puts e.backtrace.map { |l| '  %s' % l } if cli.env.debug?
-          exit EX_SOFTWARE
+        def handle_error env, ex
+          env.puts_error "#{ex.class.name}: #{ex.message}"
+          env.puts_error ex.backtrace.map { |l| '  %s' % l } if env.debug?
         end
       end
 
-      attr_reader :env
+      def setup
+        flag_verbose
+        flag_debug
+        flag_version WM::VERSION
 
-      def initialize args, stdout: $stdout
-        @arguments  = args
-        @env        = Env.new(stdout.tap { |o| o.sync = true })
-      end
+        option :f, :run_control, 'PATH', 'specify alternate run control file' do |path|
+          @env.rc_path = path
+        end
+        option :r, :require, 'PATH', 'require ruby feature' do |feature|
+          require feature
+          env.log "Loaded `#{feature}' ruby feature"
+        end
+        option :l, :layout, 'LAYOUT', 'specify layout' do |layout|
+          env.layout_class = Object.const_get layout.to_sym
+        end
+        option :w, :worker, 'WORKER', 'specify worker' do |worker|
+          env.worker = worker.to_sym
+        end
 
-      def parse_arguments!
-        option_parser.parse! @arguments
-      rescue OptionParser::InvalidOption
-        raise ArgumentError, option_parser
+        env.sync_output
       end
 
       def run
+        env.log_logger_level
         Runner.run env
       end
-
-    private
-
-      def option_parser
-        OptionParser.new do |opts|
-          opts.banner = USAGE
-          opts.separator ''
-          opts.separator 'options:'
-
-          opts.on '-v', '--verbose', 'enable verbose mode' do
-            @env.verbose = true
-            @env.log_logger_level
-          end
-          opts.on '-d', '--debug', 'enable debug mode' do
-            @env.debug = true
-            @env.log_logger_level
-          end
-          opts.on '-f', '--run-control PATH',
-            'specify alternate run control file' do |e|
-            @env.rc_path = e
-          end
-          opts.on '-r', '--require PATH', 'require ruby feature' do |feature|
-            require feature
-            log "Loaded `#{feature}' ruby feature"
-          end
-          opts.on '-l', '--layout LAYOUT', 'specify layout' do |layout|
-            @env.layout_class = Object.const_get layout.to_sym
-          end
-          opts.on '-w', Workers.types, '--worker WORKER',
-            'specify worker' do |worker|
-            @env.worker = worker.to_sym
-          end
-
-          opts.separator ''
-          opts.on_tail '-h', '--help', 'print this message' do
-            @env.print opts
-            exit
-          end
-          opts.on_tail '-V', '--version', 'print version' do
-            @env.puts WM::VERSION
-            exit
-          end
-        end
-      end
     end
   end
 end

data/lib/uh/wm/env.rb

@@ -1,6 +1,6 @@
 module Uh
   module WM
-    class Env
+    class Env < Baf::Env
       RC_PATH = '~/.uhwmrc.rb'.freeze
 
       MODIFIER  = :mod1
@@ -15,19 +15,17 @@ module Uh
       LOGGER_LEVEL_STRINGS  = %w[DEBUG INFO WARN ERROR FATAL UNKNOWN].freeze
 
       extend Forwardable
-      def_delegator   :logger, :info,   :log
-      def_delegator   :logger, :fatal,  :log_fatal
-      def_delegator   :logger, :error,  :log_error
-      def_delegator   :logger, :debug,  :log_debug
-      def_delegators  :@output, :print, :puts
+      def_delegator :logger, :info,   :log
+      def_delegator :logger, :fatal,  :log_fatal
+      def_delegator :logger, :error,  :log_error
+      def_delegator :logger, :debug,  :log_debug
 
-      attr_reader   :output, :keybinds
-      attr_accessor :verbose, :debug, :rc_path, :modifier, :modifier_ignore,
-                    :worker, :layout, :layout_class, :layout_options, :rules,
-                    :launch
+      attr_reader   :keybinds
+      attr_accessor :rc_path, :modifier, :modifier_ignore, :worker, :layout,
+                    :layout_class, :layout_options, :rules, :launch
 
-      def initialize output
-        @output           = output
+      def initialize **_
+        super
         @rc_path          = RC_PATH
         @modifier         = MODIFIER
         @modifier_ignore  = []
@@ -37,14 +35,6 @@ module Uh
         @rules            = {}
       end
 
-      def verbose?
-        !!@verbose
-      end
-
-      def debug?
-        !!@debug
-      end
-
       def layout
         @layout ||= if layout_class
           layout_class.new @layout_options

data/lib/uh/wm/run_control.rb

@@ -75,7 +75,7 @@ module Uh
       # @param arg [Class, Object, Hash] A layout class, a layout instance, or
       #   options for the default layout
       # @param options [Hash] Layout options
-      def layout arg, **options
+      def layout arg, options = {}
         case arg
         when Class
           if options.any?
@@ -144,7 +144,7 @@ module Uh
         translated_keysym = KEYSYM_TRANSLATIONS.key?(translate_key) ?
           KEYSYM_TRANSLATIONS[translate_key] :
           translate_key
-        keysym =~ /[A-Z]/ ? [translated_keysym, :shift] : translated_keysym
+        keysym.to_s =~ /[A-Z]/ ? [translated_keysym, :shift] : translated_keysym
       end
     end
   end

data/lib/uh/wm/testing/acceptance_helpers.rb

@@ -1,3 +1,5 @@
+require 'baf/testing/process'
+
 require 'uh'
 require 'uh/wm/testing/x_client'
 
@@ -5,24 +7,14 @@ module Uh
   module WM
     module Testing
       module AcceptanceHelpers
-        TIMEOUT_DEFAULT = 2
         QUIT_KEYBINDING = 'alt+shift+q'.freeze
         LOG_READY       = 'Working events'.freeze
 
         attr_reader :other_wm
 
-        def build_regexp pattern, options
-          Regexp.new(pattern, options.each_char.inject(0) do |m, e|
-            m | case e
-              when ?i then Regexp::IGNORECASE
-              when ?m then Regexp::MULTILINE
-              when ?x then Regexp::EXTENDED
-            end
-          end)
-        end
-
         def icccm_window_start
-          @icccm_window = ChildProcess.build(*%w[xmessage window])
+          @icccm_window = Baf::Testing::Process.new %w[xmessage window],
+            env_allow: %w[DISPLAY]
           @icccm_window.start
         end
 
@@ -34,57 +26,29 @@ module Uh
           'xmessage'
         end
 
-        def uhwm_run options = '-v'
-          command = %w[uhwm]
-          command << options if options
-          @interactive = @process = run command.join ' '
-        end
-
-        def uhwm
-          @process
-        end
-
         def uhwm_request_quit
           x_key QUIT_KEYBINDING
         end
 
         def uhwm_ensure_stop
-          if @process
-            x_key 'alt+shift+q'
-            @process.terminate
-          end
+          uhwm_request_quit
         end
 
-        def uhwm_wait_output message, times = 1, value = nil
-          output = -> { @process.stdout + @process.stderr }
-          timeout_until do
-            case message
-            when Regexp then (value = output.call.scan(message)).size >= times
-            when String then output.call.include? message
-            end
+        def uhwm_run_wait_ready options = '-v'
+          cmd = $_baf[:program] + options.split(' ')
+          env = Baf::Testing::ENV_WHITELIST + $_baf[:env_allow]
+          Baf::Testing::Process.new(cmd, env_allow: env).tap do |uhwm|
+            uhwm.start
+            Baf::Testing.wait_output LOG_READY, stream: -> { uhwm.output }
           end
-          value
-        rescue TimeoutError => e
-          raise <<-eoh
-expected `#{message}' (#{times}) not seen after #{e.timeout} seconds in:
-  ```\n#{output.call.lines.map { |l| "  #{l}" }.join}  ```
-          eoh
-        end
-
-        def uhwm_wait_ready
-          uhwm_wait_output LOG_READY
         end
 
-        def uhwm_run_wait_ready options = nil
-          if options then uhwm_run options else uhwm_run end
-          uhwm_wait_ready
-        end
-
-        def with_other_wm
-          @other_wm = ChildProcess.build('./bin/uhwm')
+        def with_other_wm uhwm_command
+          env = Baf::Testing::ENV_WHITELIST + $_baf[:env_allow]
+          @other_wm = Baf::Testing::Process.new uhwm_command, env_allow: env
           @other_wm.start
           yield
-          @other_wm.stop
+          uhwm_request_quit
           @other_wm = nil
         end
 
@@ -116,31 +80,6 @@ expected `#{message}' (#{times}) not seen after #{e.timeout} seconds in:
           end
           `xwininfo #{select_args} 2> /dev/null`[/Map State: (\w+)/, 1]
         end
-
-      private
-
-        def timeout_until message = 'condition not met after %d seconds'
-          timeout = ENV.key?('UHWMTEST_TIMEOUT') ?
-            ENV['UHWMTEST_TIMEOUT'].to_i :
-            TIMEOUT_DEFAULT
-          Timeout.timeout(timeout) do
-            loop do
-              break if yield
-              sleep 0.1
-            end
-          end
-        rescue Timeout::Error
-          raise TimeoutError.new(message % timeout, timeout)
-        end
-
-        class TimeoutError < ::StandardError
-          attr_reader :timeout
-
-          def initialize message, timeout
-            super message
-            @timeout = timeout
-          end
-        end
       end
     end
   end

data/lib/uh/wm/testing/headless.rb

@@ -1,4 +1,4 @@
-require 'childprocess'
+require 'baf/testing/process'
 
 module Uh
   module WM
@@ -8,15 +8,18 @@ module Uh
         DISPLAY_SCREEN  = '640x480x24'
 
         def with_xvfb
-          xvfb = ChildProcess.build(*%W[
+          xvfb = Baf::Testing::Process.new %W[
             Xvfb -ac #{DISPLAY_NAME} -screen 0 #{DISPLAY_SCREEN}
-          ])
+          ]
           xvfb.start
           original_display = ENV['DISPLAY']
           ENV['DISPLAY'] = DISPLAY_NAME
-          yield
-          ENV['DISPLAY'] = original_display
-          xvfb.stop
+          begin
+            yield
+          ensure
+            ENV['DISPLAY'] = original_display
+            xvfb.stop
+          end
         end
       end
     end

data/lib/uh/wm/testing/x_client.rb

@@ -26,7 +26,7 @@ module Uh
         end
 
         def window_id
-          @window.id
+          window.id
         end
 
         def window_name

data/lib/uh/wm/version.rb

@@ -1,5 +1,5 @@
 module Uh
   module WM
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.2'.freeze
   end
 end

data/lib/uh/wm/workers/base.rb

@@ -4,7 +4,7 @@ module Uh
       class Base
         CALLBACKS = %w[before_watch on_timeout on_read on_read_next].freeze
 
-        def initialize **_options
+        def initialize *_options
           @ios = []
         end
 

data/lib/uh/wm/workers.rb

@@ -2,9 +2,9 @@ module Uh
   module WM
     module Workers
       FACTORIES = {
-        block:  ->(options) { Blocking.new(options) },
-        kqueue: ->(options) { KQueue.new(options) },
-        mux:    ->(options) { Mux.new(options) }
+        block:  ->(options) { Blocking.new(**options) },
+        kqueue: ->(options) { KQueue.new(**options) },
+        mux:    ->(options) { Mux.new(**options) }
       }.freeze
 
       class << self
@@ -16,7 +16,7 @@ module Uh
           FACTORIES.key? type
         end
 
-        def build type, **options
+        def build type, options = {}
           (FACTORIES[type] or fail ArgumentError, "unknown worker: `#{type}'")
             .call options
         end

data/lib/uh/wm.rb

@@ -1,3 +1,4 @@
+require 'baf/cli'
 require 'forwardable'
 require 'logger'
 require 'optparse'

metadata

@@ -1,19 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: uh-wm
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Thibault Jouan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-10-22 00:00:00.000000000 Z
+date: 2022-07-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: baf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: rb-kqueue
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.4
@@ -21,6 +38,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.4
@@ -42,6 +62,9 @@ dependencies:
   name: uh-layout
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.2
@@ -49,37 +72,26 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.2
-- !ruby/object:Gem::Dependency
-  name: aruba
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.7.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.7.4
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +112,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.11'
 description: |2
     uhwm is a minimalistic tiling and stacking window manager for X. It
   shares some similarities with dwm and wmii, but is written in ruby so
@@ -147,7 +159,7 @@ homepage: https://rubygems.org/gems/uh-wm
 licenses:
 - BSD-3-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -162,9 +174,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.3.17
+signing_key:
 specification_version: 4
 summary: minimalistic tiling and stacking X window manager
 test_files: []