uh-wm 0.0.2.pre → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74533b8c4aea78f1fd611ad9a66f9003c7a70c78
-  data.tar.gz: 31ab453643a6c06b22fc7182344564976c622a5a
+  metadata.gz: ba8fdd593aed4b5a3c017c9dba5f2bf97e180b90
+  data.tar.gz: 1bc9621e7454e1fd4aaf1370eaee472ec35281eb
 SHA512:
-  metadata.gz: 32e9cdad0aecb15955af5dcebba0cdcb0424cc4cb7263e659dc96936c845cfba38de6007a972325b3e0e2b8e3ab16ebe6a611391f74c05009dcdd680d97f5f56
-  data.tar.gz: e1d903145b302e5a6ec00c00fd3e4c4bde795565a3ce5d969a8875704ff700f197c86afdf184b775a882bfa95e5aea32c4aa4be51777b6cb3841dbb0567e5566
+  metadata.gz: b7a6b5b73f564fb63fcf89724307dd9a5934b9fd3210e90c6df722ed1159928638485706090e3c94d9cddb3db4578398f83efe3c997b86e4c126974b91c855ca
+  data.tar.gz: 40cbe74253fa28aa76cf0eb5cf762bd14c1fe4ddced31a4e6143fd6751bb6eac65974bc77b45f993828e109714ce34b33c304bf8096a1c5de758a992c1a3fcfa

data/.gitignore

@@ -0,0 +1,3 @@
+/Gemfile-custom.rb
+/Gemfile.lock
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.2
+  - ruby-head
+  - 2.1
+before_install:
+  - travis_retry sudo apt-get update -qq
+  - travis_retry sudo apt-get install -qq twm x11-utils xdotool
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+notifications:
+  email:
+    - tj+travis_uh_wm@a13.fr

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+eval File.read('Gemfile-custom.rb') if File.exist?('Gemfile-custom.rb')

data/Guardfile

@@ -0,0 +1,12 @@
+directories %w[features lib spec]
+
+guard :cucumber, cli: '--format pretty --quiet', all_on_start: false do
+  watch(%r{\Afeatures/.+\.feature\z})
+end
+
+guard :rspec, cmd: 'bundle exec rspec -f doc' do
+  watch(%r{\Aspec/.+_spec\.rb\z})
+  watch(%r{\Alib/(.+)\.rb\z})         { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')        { 'spec' }
+  watch(%r{\Aspec/support/.+\.rb\z})  { 'spec' }
+end

data/LICENSE

@@ -0,0 +1,30 @@
+Copyright 2015 Thibault Jouan. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+  * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+  * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+
+  * Neither the name of the software nor the names of its contributors
+    may be used to endorse or promote products derived from this
+    software without specific prior written permission.
+
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS
+BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,68 @@
+uh-wm
+=====
+
+  uh-wm 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 with ruby code.
+
+  The layout strategy is interchangeable, the default one being the
+`uh-layout` ruby gem. A layout is a simple object obeying a defined
+protocol.
+
+  Features:
+
+  * Xinerama support;
+  * Multiple event handling strategy: blocking or multiplexing
+    (`select()`);
+  * Configuration with a run control file;
+  * Key bindings with user defined code as callback;
+  * Configurable modifier key;
+  * Support user-defined layout strategy;
+  * Program execution via key binding.
+
+  * No re-parenting (so no window decoration either);
+  * No grabbing of the modifier key;
+  * No mouse handling;
+  * Very limited ICCCM support.
+
+
+[![Version      ][badge-version-img]][badge-version-uri]
+[![Build status ][badge-build-img]][badge-build-uri]
+[![Code Climate ][badge-cclimate-img]][badge-cclimate-uri]
+
+
+Getting started
+---------------
+
+### Installation (requires ruby ~> 2.1 with rubygems)
+
+```
+$ gem install uh-wm
+```
+
+
+### Usage
+
+```
+Usage: uhwm [options]
+
+options:
+    -v, --verbose                    enable verbose mode
+    -d, --debug                      enable debug mode
+    -f, --run-control PATH           specify alternate run control file
+    -r, --require PATH               require ruby feature
+    -l, --layout LAYOUT              specify layout
+    -w, --worker WORKER              specify worker
+
+    -h, --help                       print this message
+    -V, --version                    print version
+```
+
+
+
+[badge-version-img]:  https://img.shields.io/gem/v/uh-wm.svg?style=flat-square
+[badge-version-uri]:  https://rubygems.org/gems/uh-wm
+[badge-build-img]:    https://img.shields.io/travis/tjouan/uh-wm/master.svg?style=flat-square
+[badge-build-uri]:    https://travis-ci.org/tjouan/uh-wm
+[badge-cclimate-img]: https://img.shields.io/codeclimate/github/tjouan/uh-wm.svg?style=flat-square
+[badge-cclimate-uri]: https://codeclimate.com/github/tjouan/uh-wm

data/Rakefile

@@ -0,0 +1,40 @@
+require 'tempfile'
+require 'cucumber/rake/task'
+require 'rspec/core/rake_task'
+
+XEPHYR_DISPLAY  = ':42'
+XEPHYR_CMD      = "$(command -v Xephyr) #{XEPHYR_DISPLAY} -ac -br -noreset".freeze
+XEPHYR_SCREENS  = '-screen 1436x400'.freeze
+XEPHYR_SCREENS_XINERAMA =
+  '+xinerama -origin 0,0 -screen 1920x400 -origin 1920,0 -screen 1920x400'.freeze
+
+task default: %i[features spec]
+
+Cucumber::Rake::Task.new(:features)
+
+RSpec::Core::RakeTask.new
+
+desc 'Run uhwm in a Xephyr X server'
+task :run do
+  uhwm_args = ARGV.include?('--') ?
+    ARGV.slice_after('--').to_a.last :
+    %w[-d]
+  Tempfile.create('uhwm_xinitrc') do |xinitrc|
+    xinitrc.write <<-eoh
+[ -f $HOME/.Xdefaults ] && xrdb $HOME/.Xdefaults
+#xkbcomp #{ENV['DISPLAY']} #{XEPHYR_DISPLAY}
+xmodmap -display #{ENV['DISPLAY']} -pke | xmodmap -
+xsetroot -solid SpringGreen
+echo "######## UHWM START ########"
+./bin/uhwm #{uhwm_args.join ' '}
+echo "######## UHWM END ##########"
+    eoh
+    xinitrc.flush
+    sh "xinit #{xinitrc.path} --  %s" % [
+      XEPHYR_CMD,
+      ENV.key?('UHWM_XINERAMA') ?
+        XEPHYR_SCREENS_XINERAMA :
+        XEPHYR_SCREENS
+    ].join(' ')
+  end
+end

data/bin/uhwm

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'uh/wm'
+
+Uh::WM::CLI.run(ARGV)

data/config/cucumber.yaml

@@ -0,0 +1 @@
+default: --require features/support --require features/steps

data/features/actions/execute.feature

@@ -0,0 +1,9 @@
+Feature: `execute' action keyword
+
+  Scenario: executes the given command in a shell with current standard output
+    Given uhwm is running with this run control file:
+      """
+      key(:f) { execute 'echo etucexe_tset | rev' }
+      """
+    When I press the alt+f keys
+    Then the output must contain "test_execute"

data/features/actions/layout_delegation.feature

@@ -0,0 +1,31 @@
+Feature: `layout_*' action keywords
+
+  Background:
+    Given a file named layout.rb with:
+      """
+      class Layout
+        def register _; end
+
+        def handle_some_action arg
+          puts arg
+        end
+      end
+      """
+
+  Scenario: delegates messages matching `layout_*' to `layout_handle_*'
+    Given a run control file with:
+      """
+      key(:f) { layout_some_action :testing_some_action }
+      """
+    And uhwm is running
+    When I press the alt+f keys
+    Then the output must contain ":testing_some_action"
+
+  Scenario: logs an error about unimplemented messages
+    Given a run control file with:
+      """
+      key(:f) { layout_unknown_action }
+      """
+    And uhwm is running
+    When I press the alt+f keys
+    Then the output must match /layout.+no.+implem.+handle_unknown_action/i

data/features/actions/quit.feature

@@ -0,0 +1,9 @@
+Feature: `quit' action keyword
+
+  Scenario: requests quit when invoked
+    Given uhwm is running with this run control file:
+      """
+      key(:f) { quit }
+      """
+    When I press the alt+f keys
+    Then uhwm must terminate successfully

data/features/cli/debug.feature

@@ -0,0 +1,5 @@
+Feature: debug CLI option
+
+  Scenario: raises the logger level to DEBUG
+    When I run uhwm with option -d
+    Then the output must match /log.+debug.+level/i

data/features/cli/layout.feature

@@ -0,0 +1,15 @@
+Feature: layout CLI option
+
+  Scenario: specifies the layout class
+    Given a file named layout.rb with:
+      """
+      class MyLayout
+        def register _; end
+      end
+      """
+    When I run uhwm with option -v -r./layout -l MyLayout
+    Then the output must match /layout.+mylayout/i
+
+  Scenario: resolves layout class from the root namespace
+    When I run uhwm with option -v -l Layout
+    Then the output must contain "uninitialized constant Layout"

data/features/cli/require.feature

@@ -0,0 +1,5 @@
+Feature: require CLI option
+
+  Scenario: requires a ruby feature
+    When I run uhwm with option -v -r abbrev
+    Then the output must match /load.+abbrev.+ruby feature/i

data/features/cli/run_control.feature

@@ -0,0 +1,9 @@
+Feature: run control file path CLI option
+
+  Scenario: specifies run control file path
+    Given a file named uhwmrc.rb with:
+      """
+      puts 'run control evaluation'
+      """
+    When I run uhwm with option -f uhwmrc.rb
+    Then the output must contain "run control evaluation"

data/features/cli/usage.feature

@@ -0,0 +1,11 @@
+Feature: CLI usage
+
+  Scenario: prints the usage when unknown option switch is given
+    When I run uhwm with option --unknown-option
+    Then the exit status must be 64
+    And the output must contain exactly the usage
+
+  Scenario: prints the help when -h option is given
+    When I run uhwm with option -h
+    Then uhwm must terminate successfully
+    And the output must contain exactly the usage

data/features/cli/verbose.feature

@@ -0,0 +1,5 @@
+Feature: verbose CLI option
+
+  Scenario: raises the logger level to INFO
+    When I run uhwm with option -v
+    Then the output must match /log.+info.+level/i

data/features/cli/version.feature

@@ -0,0 +1,6 @@
+Feature: version CLI option
+
+  Scenario: prints the current version on standard output
+    When I run uhwm with option --version
+    Then uhwm must terminate successfully
+    And the output must contain exactly the version

data/features/cli/worker.feature

@@ -0,0 +1,9 @@
+Feature: worker CLI option
+
+  Scenario: uses the blocking worker when `block' is given
+    When I run uhwm with option -v -w block
+    Then the output must match /work.+event.+block/i
+
+  Scenario: uses the multiplexing worker when `mux' is given
+    When I run uhwm with option -v -w mux
+    Then the output must match /work.+event.+mux/i

data/features/layout/manage.feature

@@ -0,0 +1,12 @@
+Feature: layout client management
+
+  Background:
+    Given uhwm is running
+
+  Scenario: maps new client window
+    When a window requests to be mapped
+    Then the window must be mapped
+
+  Scenario: focuses new client window
+    When a window requests to be mapped
+    Then the window must be focused

data/features/layout/protocol.feature

@@ -0,0 +1,24 @@
+Feature: layout protocol
+
+  Background:
+    Given a file named layout.rb with:
+      """
+      class Layout
+        def register display
+          puts display
+        end
+
+        def << client
+          puts client
+        end
+      end
+      """
+
+  Scenario: tells the layout to register with #register message
+    When I run uhwm with option -r./layout -l Layout
+    Then the output must contain current display
+
+  Scenario: tells the layout to manage a client with #<< message
+    Given uhwm is running with options -v -r./layout -l Layout
+    When a window requests to be mapped
+    Then the output must contain the window name

data/features/layout/unmanage.feature

@@ -0,0 +1,10 @@
+Feature: layout client unmanagement
+
+  Background:
+    Given uhwm is running
+    And a first window is mapped
+    And a second window is mapped
+
+  Scenario: maps another window
+    When the second window requests to be unmapped
+    Then the first window must be mapped

data/features/manager/check_other_wm.feature

@@ -0,0 +1,8 @@
+Feature: checking if another window manager is running
+
+  @other_wm_running
+  Scenario: fails when another window manager is running
+    Given another window manager is running
+    When I start uhwm
+    Then the exit status must be 70
+    And the output must match /error.+other.+window.+manager/i

data/features/manager/input_events.feature

@@ -0,0 +1,8 @@
+Feature: input events selection
+
+  Scenario: selects the appropriate input event mask for a window manager
+    Given uhwm is running
+    Then the input event mask must include StructureNotifyMask
+    And the input event mask must include SubstructureNotifyMask
+    And the input event mask must include SubstructureRedirectMask
+    And the input event mask must include PropertyChangeMask

data/features/manager/manage.feature

@@ -0,0 +1,14 @@
+Feature: manager client management
+
+  Background:
+    Given uhwm is running
+
+  Scenario: logs when a new client is managed
+    When a window requests to be mapped
+    Then the output must match /manag.+xclient/i
+
+  Scenario: manages a given client only once
+    When a window requests to be mapped 2 times
+    And I quit uhwm
+    Then the output must not match /manag.*\n.*manag/mi
+    And the output must not match /xerror/i

data/features/manager/unmanage.feature

@@ -0,0 +1,13 @@
+Feature: manager client unmanagement
+
+  Background:
+    Given uhwm is running
+    And a window is managed
+
+  Scenario: logs when a new client is unmanaged
+    When the window requests to be unmapped
+    Then the output must match /unmanag.+xclient/i
+
+  Scenario: unmanages client on destroy notify X events
+    When the window is destroyed
+    Then the output must match /unmanag.+xclient/i