uh-wm 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3607acc6f3a156a4fe6ecfdd4c960daecdde3bc
-  data.tar.gz: 9aac8a32b1d1619e055e0c5af14e28d8033dfe9f
+  metadata.gz: a9e65ddc3d9f3e3f406b624138ef47c86531380e
+  data.tar.gz: 095aac6361586080213412cb40d1ba6a7393150a
 SHA512:
-  metadata.gz: f332e7a7d0b81b91d356f7e6345f073eb551d0ea6cabe361285df90c62a14b3cecb29c32f339b5fb032d47c343135b7bb676fb026111ef66463bd38f548a504e
-  data.tar.gz: 2e0fbe32e68ef89136a64045f55180fcf3211bd9dc1a4b6dfba461356e3a8076be7d64dcbb989fcacd07d4058dd756c6748315a484c0376d1cacbf304b134a98
+  metadata.gz: 3d3733270d72b481d05fded4c6bd0a66dcbdce5be277c639a6aba35ef613128276251f1795d70aa876ec375f85e7adc9d9da5ccf6a40576b6ff1aa1d38fa69da
+  data.tar.gz: ec55836544feb58833aae7168adc823640a1dc5d27531a3d1af2b6d71442f6847b7aba9fc4906b78f06382eb178ee65a891813c14b9c267386953701d2478c8b

data/README.md

@@ -1,18 +1,18 @@
-uh-wm
-=====
+uhwm
+====
 
 [![Version      ][badge-version-img]][badge-version-uri]
 [![Build status ][badge-build-img]][badge-build-uri]
 [![Code Climate ][badge-cclimate-img]][badge-cclimate-uri]
 
 
-  uh-wm is a minimalistic tiling and stacking window manager for X. It
+  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
 you can configure and extend features directly with ruby code.
 
   The layout strategy is interchangeable, the default one being the
 `uh-layout` ruby gem. A layout is a simple ruby object responding to
-specific messages.
+specific messages, so it's easy to write your own layout.
 
   Main features:
 
@@ -31,17 +31,19 @@ specific messages.
   * very limited ICCCM support.
 
 
-Getting started
----------------
+Installation
+------------
 
-### Installation (requires ruby ~> 2.1 with rubygems)
+  uhwm requires ruby ~> 2.1 with rubygems, and is currently
+distributed as the `uh-wm` ruby gem.
 
 ```
 $ gem install uh-wm
 ```
 
 
-### Usage
+Usage
+-----
 
 ```
 Usage: uhwm [options]
@@ -59,6 +61,69 @@ options:
 ```
 
 
+Configuration
+-------------
+
+  uhwm can be configured with a run control file, written in ruby. A
+simple example is provided below, more details will be available in
+the [`RunControl` class documentation][run_control_doc].
+
+``` ruby
+DMENU     = 'dmenu_run -b'.freeze
+VT        = 'urxvt'.freeze
+BROWSERS  = %w[
+  arora chromium firebird firefox galeon iceweasel konqueror pentadactyl
+  phoenix vimperator
+].freeze
+
+
+modifier :mod1                # This key will be 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(: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
+                              # their X equivalent (`return').
+
+rule BROWSERS do              # Move windows to the `www' view when their app
+  layout_view_set 'www'       # class matches either /\Aarora/, /\Achromium/… etc
+end
+
+launch do                         # Execute urxvt program twice, synchronously.
+  execute! VT                     # `execute!' is a variant of `execute' which
+  execute! VT                     # will only return when a window is mapped.
+  layout_client_column_set :succ  # Move last mapped window to next column.
+end
+```
+
+  Blocks given to `key`, `rule`, `launch` are executed in a special
+context providing access to methods named "actions", which are
+described in next section.
+
+[run_control_doc]: http://www.rubydoc.info/gems/uh-wm/Uh/WM/RunControl
+
+
+Actions
+-------
+
+  The actions DSL implements a few built-in messages, but also acts as
+a proxy to the layout. Any message prefixed with `layout_` will be
+forwarded to the layout, with the prefix stripped. That is, if
+`layout_view_sel '2'` is evaluated, then the layout will receive the
+`view_sel` message with `"2"` as argument. Up to date information is
+available in the [`ActionsHandler` class documentation][actions_doc]
+
+| Message       | Arguments | Description
+| ------------- | --------- | -----------------------------------
+| quit          |           | requests uhwm to terminate
+| execute       | command   | executes given `command` in a shell
+| kill_current  |           | kills layout current client
+| layout\_\*    | \*\_      | forwards messages to layout
+
+[actions_doc]: http://www.rubydoc.info/gems/uh-wm/Uh/WM/ActionsHandler
+
+
 
 [badge-version-img]:  https://img.shields.io/gem/v/uh-wm.svg?style=flat-square
 [badge-version-uri]:  https://rubygems.org/gems/uh-wm

data/lib/uh/wm/cli.rb

@@ -81,7 +81,7 @@ module Uh
             exit
           end
           opts.on_tail '-V', '--version', 'print version' do
-            @env.puts VERSION
+            @env.puts WM::VERSION
             exit
           end
         end

data/lib/uh/wm/version.rb

@@ -1,5 +1,5 @@
 module Uh
   module WM
-    VERSION = '0.0.7'
+    VERSION = '0.0.8'
   end
 end

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

@@ -0,0 +1,31 @@
+module Uh
+  module WM
+    module Workers
+      class KQueue < Base
+        TIMEOUT_DEFAULT = 1
+
+        def initialize timeout: TIMEOUT_DEFAULT
+          super
+          @queue = ::KQueue::Queue.new
+        end
+
+        def watch io
+          @queue.watch_stream_for_read io.to_io do
+            @on_read.call
+          end
+        end
+
+        def on_timeout &block
+          ::KQueue::Watcher.new(@queue, 1, :timer, [], 1000, proc do |event|
+            block.call
+          end)
+        end
+
+        def work_events
+          @before_watch.call if @before_watch
+          events = @queue.process
+        end
+      end
+    end
+  end
+end

data/lib/uh/wm/workers.rb

@@ -3,6 +3,7 @@ module Uh
     module Workers
       FACTORIES = {
         block:  ->(options) { Blocking.new(options) },
+        kqueue: ->(options) { KQueue.new(options) },
         mux:    ->(options) { Mux.new(options) }
       }.freeze
 

data/lib/uh/wm.rb

@@ -1,6 +1,7 @@
 require 'forwardable'
 require 'logger'
 require 'optparse'
+require 'rb-kqueue'
 require 'uh'
 
 require 'uh/wm/env_logging'
@@ -15,9 +16,11 @@ require 'uh/wm/logger_formatter'
 require 'uh/wm/manager'
 require 'uh/wm/run_control'
 require 'uh/wm/runner'
+require 'uh/wm/version'
 require 'uh/wm/workers'
 require 'uh/wm/workers/base'
 require 'uh/wm/workers/blocking'
+require 'uh/wm/workers/kqueue'
 require 'uh/wm/workers/mux'
 
 module Uh

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: uh-wm
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Thibault Jouan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-20 00:00:00.000000000 Z
+date: 2015-05-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rb-kqueue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
   name: uh
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +150,7 @@ files:
 - lib/uh/wm/workers.rb
 - lib/uh/wm/workers/base.rb
 - lib/uh/wm/workers/blocking.rb
+- lib/uh/wm/workers/kqueue.rb
 - lib/uh/wm/workers/mux.rb
 homepage: https://rubygems.org/gems/uh-wm
 licenses:
@@ -162,3 +177,4 @@ signing_key:
 specification_version: 4
 summary: minimalistic tiling and stacking window manager for X
 test_files: []
+has_rdoc: