uh-wm 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afe14a18b77ca68f10d03fabbbc634a2ec9e3e4c
-  data.tar.gz: 76fa551b050eeb4a1c1f8210139a680450788a4a
+  metadata.gz: d30b881b7363a539a259011ee767eb42b941fe65
+  data.tar.gz: 4ae10cdb8a3d9a1da9b9ec4c55bf1c88890a6897
 SHA512:
-  metadata.gz: deb8569d3d342d0bf77a46e17b32af1f28be149c3fe023e87e7ba866262d88a47b3f05761077cbf0e7d693e57ad0fb526c4e60fa4c76af3d081c23648b56ce9d
-  data.tar.gz: f13232ba3b1292aac1b4589390068443732f9dcb0c61174323f10400a03347831075d2d36f3b1c9b90ba36f1144ac3f92d67b813f40ef1f1ccc94587e9510188
+  metadata.gz: 0bdbddabd4ed09e97349bd80ed38b011aa33a816a8feab4b3e5cf9f417500921e1ffe943df8697217cef4d3d4d00450ae91d370abda2ed60060048bf749bc0fd
+  data.tar.gz: af6bc893f76cc828b33dc78bd02ed6f182ee580dc375653cc206810892380b370c75c65d81017800d2b768cec82c2e9126c2328283b82dc67c7cdc9601c89c90

data/README.md

@@ -26,6 +26,7 @@ specific messages, so it's easy to write your own layout.
   * external program execution;
   * no re-parenting (therefore, no window decoration either);
   * no grabbing of the modifier key alone;
+  * no default key binding except for exiting;
   * no mouse event handling;
   * no EWMH support;
   * very limited ICCCM support.
@@ -37,8 +38,8 @@ Installation
   uhwm requires ruby ~> 2.1 with rubygems, and is currently
 distributed as the `uh-wm` ruby gem.
 
-```
-$ gem install uh-wm
+``` shell
+gem install uh-wm   # install the gem or update to last release
 ```
 
 
@@ -66,7 +67,12 @@ Configuration
 
   uhwm can be configured with a run control file written in ruby. A
 simple example is provided below, more details are available in the
-[`RunControl` class documentation][run_control_doc].
+[`RunControl` class documentation][run_control_doc]. The file must be
+located at the `~/.uhwmrc.rb` path.
+
+  Please note that uhwm ships with only one key binding: `mod+shift+q`
+which is bound to the `quit` action. You *need* to write your own
+configuration file if you want to do something useful with uhwm.
 
 ``` ruby
 DMENU     = 'dmenu_run -b'
@@ -127,6 +133,23 @@ available in the [`ActionsHandler` class documentation][actions_doc]
 Hacking uhwm
 ------------
 
+  If you need to work with uhwm source code, you will need a local clone
+of the repository. A bundler `Gemfile` is provided, and if you are new
+to ruby and rubygems, we recommend that you use bundler to manage
+dependencies. Refer to the bundler documentation if you need no know
+more than this short help:
+
+  * Run `bundle install` after you update the repository sources to a
+    new version, or when you changes branches which affect the
+    `Gemfile`
+  * Prefix every ruby executable scripts (`bin/uhwm`, `rake`…) with
+    `bundle exec`, for example `bundle exec rake spec`
+
+  Please note this not the "supported" way of using uhwm, we recommend
+that you use the ruby gem. The `master` branch can sometimes receive
+experimental features which may need improvements before a stable gem
+release.
+
 ### Installation with bundler
 
 ``` shell
@@ -144,7 +167,8 @@ rake spec       # Run unit test suite
 rspec           # Run unit test suite
 ```
 
-  Prefix the commands as `bundle exec COMMAND` to use bundler.
+  Prefix the commands as `bundle exec COMMAND` if you're using
+bundler.
 
 ### Running uhwm within a nested X session
 
@@ -377,6 +401,11 @@ key :m do
   end
 end
 ```
+_I get a \`cannot load such file -- uh/wm (LoadError)\` how do I fix?_
+
+  You are probably not using the gem. If you want to use uhwm from a
+local git clone or if you did a custom install, try to use bundler or
+to modify the ruby load path (set `RUBYOPT=lib` for example).
 
 
 

data/lib/uh/wm/env.rb

@@ -22,17 +22,19 @@ module Uh
       def_delegators  :@output, :print, :puts
 
       attr_reader   :output, :keybinds
-      attr_accessor :verbose, :debug, :rc_path, :modifier, :worker,
-                    :layout, :layout_class, :layout_options, :rules, :launch
+      attr_accessor :verbose, :debug, :rc_path, :modifier, :modifier_ignore,
+                    :worker, :layout, :layout_class, :layout_options, :rules,
+                    :launch
 
       def initialize output
-        @output         = output
-        @rc_path        = RC_PATH
-        @modifier       = MODIFIER
-        @keybinds       = KEYBINDS.dup
-        @layout_options = {}
-        @worker         = :block
-        @rules          = {}
+        @output           = output
+        @rc_path          = RC_PATH
+        @modifier         = MODIFIER
+        @modifier_ignore  = []
+        @keybinds         = KEYBINDS.dup
+        @layout_options   = {}
+        @worker           = WORKER
+        @rules            = {}
       end
 
       def verbose?

data/lib/uh/wm/manager.rb

@@ -8,13 +8,14 @@ module Uh
                     Events::STRUCTURE_NOTIFY_MASK
       DEFAULT_GEO = Geo.new(0, 0, 320, 240).freeze
 
-      attr_reader :modifier, :display, :clients
+      attr_reader :modifier, :modifier_ignore, :display, :clients
 
-      def initialize events, modifier, display = Display.new
-        @events   = events
-        @modifier = modifier
-        @display  = display
-        @clients  = []
+      def initialize events, mod, mod_ignore = [], display = Display.new
+        @events           = events
+        @modifier         = mod
+        @modifier_ignore  = mod_ignore
+        @display          = display
+        @clients          = []
       end
 
       def to_io
@@ -43,7 +44,9 @@ module Uh
       def grab_key keysym, mod = nil
         mod_mask = KEY_MODIFIERS[@modifier]
         mod_mask |= KEY_MODIFIERS[mod] if mod
-        @display.grab_key keysym.to_s, mod_mask
+        combine_modifier_masks(@modifier_ignore) do |ignore_mask|
+          @display.grab_key keysym.to_s, mod_mask | ignore_mask
+        end
       end
 
       def configure window
@@ -104,10 +107,12 @@ module Uh
       end
 
       def handle_key_press event
-        key_selector = event.modifier_mask & KEY_MODIFIERS[:shift] == 1 ?
-          [event.key.to_sym, :shift] :
-          event.key.to_sym
-        @events.emit :key, *key_selector
+        case remove_modifier_masks event.modifier_mask, @modifier_ignore
+        when KEY_MODIFIERS[@modifier]
+          @events.emit :key, event.key.to_sym
+        when KEY_MODIFIERS[@modifier] | KEY_MODIFIERS[:shift]
+          @events.emit :key, event.key.to_sym, :shift
+        end
       end
 
       def handle_configure_request event
@@ -148,6 +153,21 @@ module Uh
         @display.listen_events INPUT_MASK
         @display.sync false
       end
+
+      def combine_modifier_masks mods
+        yield 0
+        (1..mods.size).flat_map { |n| mods.combination(n).to_a }.each do |cmb|
+          yield cmb.map { |e| KEY_MODIFIERS[e] }.inject &:|
+        end
+      end
+
+      def remove_modifier_masks mask, remove
+        return mask unless remove.any?
+        mask & ~(@modifier_ignore
+          .map    { |e| KEY_MODIFIERS[e] }
+          .inject &:|
+        )
+      end
     end
   end
 end

data/lib/uh/wm/run_control.rb

@@ -90,12 +90,13 @@ module Uh
         end
       end
 
-      # Defines the modifier key to use for key bindings
+      # Defines the modifier masks to use for key bindings
       # @example
       #   modifier :mod1 # Use `mod1' as modifier
       # @param keysym [Symbol] X key sym
-      def modifier keysym
-        @env.modifier = keysym
+      def modifier keysym, ignore: []
+        @env.modifier         = keysym
+        @env.modifier_ignore  = [*ignore]
       end
 
       # Declares a client rule

data/lib/uh/wm/runner.rb

@@ -37,7 +37,7 @@ module Uh
       end
 
       def manager
-        @manager ||= Manager.new(@events, @env.modifier)
+        @manager ||= Manager.new(@events, @env.modifier, @env.modifier_ignore)
       end
 
       def evaluate_run_control

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

@@ -0,0 +1,24 @@
+require 'childprocess'
+
+module Uh
+  module WM
+    module Testing
+      module Headless
+        DISPLAY_NAME    = ':42'
+        DISPLAY_SCREEN  = '640x480x24'
+
+        def with_xvfb
+          xvfb = ChildProcess.build(*%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
+        end
+      end
+    end
+  end
+end

data/lib/uh/wm/version.rb

@@ -1,5 +1,5 @@
 module Uh
   module WM
-    VERSION = '0.0.13'
+    VERSION = '0.0.14'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uh-wm
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - Thibault Jouan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-01 00:00:00.000000000 Z
+date: 2015-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb-kqueue
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: headless
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -148,6 +134,7 @@ files:
 - lib/uh/wm/run_control.rb
 - lib/uh/wm/runner.rb
 - lib/uh/wm/testing/acceptance_helpers.rb
+- lib/uh/wm/testing/headless.rb
 - lib/uh/wm/testing/x_client.rb
 - lib/uh/wm/version.rb
 - lib/uh/wm/workers.rb