rumai 3.0.0 → 3.1.0

data/doc/intro.erb

@@ -1,30 +1,42 @@
 %#--
-%# Copyright 2008 Suraj N. Kurapati
-%# See the LICENSE file for details.
+%# Copyright protects this work.
+%# See LICENSE file for details.
 %#++
 
 % api_url = './api/index.html'
-% repo_url = 'http://github.com/sunaku/' + $program
-% repo_scm = '[Git](http://git-scm.com)'
+% src_url = 'http://github.com/sunaku/' + $program
+% src_scm = '[Git](http://git-scm.com)'
+
 
 %|chapter "Introduction"
+
+
   %|project
+
     <%= $project %> is a [Ruby](<%= ruby_url %>) interface to the [wmii](<%= wmii_url %>) window manager.
 
-    * It excels at dynamic arrangement of clients, columns, views, and tags.
 
+  * <%= xref "History", "What's new?" %> --- history of project releases.
+  * [Source code](<%= src_url %>) --- obtain via <%= src_scm %> or browse online.
+  * [API reference](<%= api_url %>) --- documentation for source code.
+  * [Project home](<%= $website %>) --- the <%= $project %> project home page.
+
+  To get help or provide feedback, simply
+  <%= xref "License", "contact the author(s)" %>.
+
+
+  %|section "Features"
+
+    <%= $project %> is exciting because:
+
+    * It excels at dynamic arrangement of clients, columns, views, and tags.
     * It provides an <%= xref 'shell', 'interactive shell' %> for live entertainment and experimentation.
+    * It provides a pure Ruby client for the [9P2000 protocol](<%= p9p_url %>), upon which wmii's [IXP file-system interface](<%= wmii_ixp_url %>) is built.
 
-    * It contains a pure Ruby client for the [9P2000 protocol](<%= p9p_url %>) on which wmii's [IXP file-system interface](<%= wmii_ixp_url %>) is built.
 
-  These features distinguish <%= $project %> from the competition:
-  * [r9p](http://libs.suckless.org/r9p)
-  * [Rii](http://rubyforge.org/projects/rii/)
-  * [Ruby-IXP](http://home.gna.org/rubyixp/)
-  * [ruby-wmii](http://eigenclass.org/hiki.rb?wmii+ruby)
+  %|section "Etymology"
 
-  %|paragraph "Etymology"
-    The word "wmii" is incredibly difficult to pronounce because it is an abbreviation, not an acronym.  If we were to treat it as an acronym, the closest pronounciation would be, in my mind, something like "vim-eye".
+    The word "wmii" is difficult to pronounce because it is an abbreviation, not an acronym.  If we were to treat it as an acronym, the closest pronounciation would be, in my mind, something like "vim-eye".
 
     Since this is a Ruby library, I added a "roo" and worked it through:
 
@@ -34,61 +46,25 @@
 
     And thus we get "Rumai".
 
-  %|section "Logistics"
-    * <%= xref "History", "Release notes" %> --- history of project releases.
-    * [Source code](<%= repo_url %>) --- obtain via <%= repo_scm %> or browse online.
-    * [API reference](<%= api_url %>) --- documentation for source code.
-    * [Project home](<%= $website %>) --- the <%= $project %> project home page.
-
-    To get help or provide feedback, simply
-    <%= xref "License", "contact the author(s)" %>.
-
-    %|paragraph "Version numbers"
-      <%= $project %> releases are numbered in *major.minor.patch*
-      form according to the [RubyGems rational versioning
-      policy](http://www.rubygems.org/read/chapter/7), which
-      can be summarized thus:
-
-      <table markdown="1">
-        <thead>
-          <tr>
-            <td rowspan="2">What increased in the version number?</td>
-            <td colspan="3">The increase indicates that the release:</td>
-          </tr>
-          <tr>
-            <th>Is backward compatible?</th>
-            <th>Has new features?</th>
-            <th>Has bug fixes?</th>
-          </tr>
-        </thead>
-        <tbody>
-          <tr>
-            <th>major</th>
-            <td style="background-color: #FFE4E1;">No</td>
-            <td>Yes</td>
-            <td>Yes</td>
-          </tr>
-          <tr>
-            <th>minor</th>
-            <td>Yes</td>
-            <td>Yes</td>
-            <td>Yes</td>
-          </tr>
-          <tr>
-            <th>patch</th>
-            <td>Yes</td>
-            <td style="background-color: #FFE4E1;">No</td>
-            <td>Yes</td>
-          </tr>
-        </tbody>
-      </table>
 
   %|section "License"
+
     %< "../LICENSE"
 
+
   %|section "Credits"
+
     <%= $project %> is made possible by
-    <%= xref "History", "contributions" %>
+    %= xref "History", "contributions"
     from users like you:
 
     %< "../CREDITS"
+
+
+  %|section "Related works"
+
+    * [r9p](http://libs.suckless.org/r9p)
+    * [Rii](http://rubyforge.org/projects/rii/)
+    * [Ruby-IXP](http://home.gna.org/rubyixp/)
+    * [ruby-wmii](http://eigenclass.org/hiki.rb?wmii+ruby)
+

data/doc/setup.erb

@@ -1,10 +1,14 @@
 %#--
-%# Copyright 2008 Suraj N. Kurapati
-%# See the LICENSE file for details.
+%# Copyright protects this work.
+%# See LICENSE file for details.
 %#++
 
+
 %|chapter "Setup"
+
+
   %|section "Requirements"
+
     Your system needs the following software to run <%= $project %>.
 
     | Software                        | Description               | Notes                               |
@@ -13,7 +17,9 @@
     | [RubyGems](http://rubygems.org) | Ruby packaging system     | Version 1.3.1 or newer is required. |
     | [wmii](<%= wmii_url %>)         | Window manager            | Version 3.6 or newer is required.   |
 
+
   %|section "Installation"
+
     You can install <%= $project %> by running this command:
 
         gem install <%= $program %>
@@ -29,7 +35,9 @@
     If you do not see such output, you may
     <%= xref "License", "ask the author(s)" %> for help.
 
+
   %|section "Manifest"
+
     You will see the following items inside <%= $project %>'s installation
     directory, whose path you can determine by running this command:
 
@@ -54,3 +62,46 @@
       * <tt>index.erb</tt> --- source of this user manual.
 
     * <tt>LICENSE</tt> --- copyright notice and legal conditions.
+
+
+  %|section "Version numbers"
+
+    <%= $project %> releases are numbered in *major.minor.patch*
+    form according to the [RubyGems rational versioning
+    policy](http://www.rubygems.org/read/chapter/7), which
+    can be summarized thus:
+
+    <table markdown="1">
+      <thead>
+        <tr>
+          <td rowspan="2">What increased in the version number?</td>
+          <td colspan="3">The increase indicates that the release:</td>
+        </tr>
+        <tr>
+          <th>Is backward compatible?</th>
+          <th>Has new features?</th>
+          <th>Has bug fixes?</th>
+        </tr>
+      </thead>
+      <tbody>
+        <tr>
+          <th>major</th>
+          <td style="background-color: #FFE4E1;">No</td>
+          <td>Yes</td>
+          <td>Yes</td>
+        </tr>
+        <tr>
+          <th>minor</th>
+          <td>Yes</td>
+          <td>Yes</td>
+          <td>Yes</td>
+        </tr>
+        <tr>
+          <th>patch</th>
+          <td>Yes</td>
+          <td style="background-color: #FFE4E1;">No</td>
+          <td>Yes</td>
+        </tr>
+      </tbody>
+    </table>
+

data/doc/usage.erb

@@ -1,10 +1,14 @@
 %#--
-%# Copyright 2008 Suraj N. Kurapati
-%# See the LICENSE file for details.
+%# Copyright protects this work.
+%# See LICENSE file for details.
 %#++
 
+
 %|chapter "Usage"
+
+
   %|section "Concepts"
+
     Client
     : Any graphical program (a "window") that is running in your X session.
 
@@ -26,7 +30,9 @@
         * can overlap each other
         * float above clients in the managed areas
 
+
   %|section "Command-line interface"
+
     When you run this command:
 
         <%= $program %> --help
@@ -35,10 +41,12 @@
 
     <pre><%= verbatim `ruby bin/#{$program} --help` %></pre>
 
+
     %|paragraph "Interactive shell", "shell"
+
       When you run this command:
 
-          <%= $program %>
+          %= $program
 
       An IRB session will begin, showing you a command prompt like this:
 
@@ -50,7 +58,9 @@
 
       The next thing to note is that **tab completion** is enabled by default. So you can type part of a command and press the TAB key to see a list of possible completions.
 
+
   %|section "Tutorial"
+
     Now that you know <%= xref "shell", "how to start the interactive shell" %>, let us walk through a quick demonstration that highlights the main features of <%= $project %>.  You can follow along by copying & pasting the presented commands into the interactive shell.
 
     <%
@@ -73,8 +83,10 @@
       }.gsub(/^\s+/, '')
     %>
 
+
     %|section "Automated client arrangement"
-      <%= open_terms %>
+
+      %= open_terms
 
       Arrange all clients in a grid:
 
@@ -94,10 +106,12 @@
       curr_view.arrange_as_larswm
       </code>
 
-      <%= close_terms %>
+      %= close_terms
+
 
     %|section "Multiple client grouping"
-      <%= open_terms %>
+
+      %= open_terms
 
       Add the red, green, and blue terminals into the "grouping":
 
@@ -127,14 +141,16 @@
       grouping.each {|c| c.send "toggle" }
       </code>
 
-      <%= close_terms %>
+      %= close_terms
 
       In summary, you can select multiple clients (by adding them to the "grouping") and perform operations on them. This is useful when you want to do something with a group of clients but do not want to manually focus one, perform the action, focus the next one, and so on.
 
       Another important aspect is that selected clients stay selected until they are unselected. This allows you to continue performing tasks on the selection without having to reselect the same clients after every operation.
 
+
     %|section "Easy column manipulation"
-      <%= open_terms %>
+
+      %= open_terms
 
       You can insert a group of clients to the top, bottom, or after the currently focused client of _any_ column using Array-like methods.
 
@@ -184,10 +200,12 @@
       curr_view.areas[3].push terms
       </code>
 
-      <%= close_terms %>
+      %= close_terms
+
 
     %|section "Easy client manipulation"
-      <%= open_terms %>
+
+      %= open_terms
 
       Obtain a reference to the red client:
 
@@ -248,9 +266,11 @@
       red.send curr_view.areas.last
       </code>
 
-      <%= close_terms %>
+      %= close_terms
+
 
     %|section "Traversing the file system"
+
       Show the root node of wmii's IXP file system:
 
       <code>
@@ -312,8 +332,13 @@
       b.exist? #=> false
       </code>
 
+
     %|section "Available commands"
+
       Refer to the `Rumai` module in the [API documentation](api/index.html) for a complete list of commands (method calls, really) and their documentation.
 
+
   %|section "Scripting your wmiirc", 'wmiirc'
+
     One important application of <%= $project %> is the support of Ruby-based <tt>wmiirc</tt> configuration files.  For a solid example of such application, take a look at [my personal <tt>wmiirc</tt>](http://github.com/sunaku/wmiirc/).
+

data/lib/rumai.rb

@@ -1,6 +1,6 @@
 #--
-# Copyright 2008 Suraj N. Kurapati
-# See the LICENSE file for details.
+# Copyright protects this work.
+# See LICENSE file for details.
 #++
 
 require 'rubygems'
@@ -8,8 +8,8 @@ gem 'inochi', '~> 1'
 require 'inochi'
 
 Inochi.init :Rumai,
-  :version => '3.0.0',
-  :release => '2009-05-11',
+  :version => '3.1.0',
+  :release => '2009-10-02',
   :website => 'http://snk.tuxfamily.org/lib/rumai/',
   :tagline => 'Ruby interface to the wmii window manager',
   :develop => {

data/lib/rumai/fs.rb

@@ -1,7 +1,7 @@
 # File system abstractions over the 9P2000 protocol.
 #--
-# Copyright 2006 Suraj N. Kurapati
-# See the LICENSE file for details.
+# Copyright protects this work.
+# See LICENSE file for details.
 #++
 
 require 'rumai/ixp'

data/lib/rumai/ixp.rb

@@ -1,7 +1,7 @@
 # An interface to wmii's IXP library for Rumai.
 #--
-# Copyright 2007 Suraj N. Kurapati
-# See the LICENSE file for details.
+# Copyright protects this work.
+# See LICENSE file for details.
 #++
 
 require 'rumai/ixp/message'

data/lib/rumai/ixp/message.rb

@@ -5,8 +5,8 @@
 # See http://swtch.com/plan9port/man/man9/
 #
 #--
-# Copyright 2007 Suraj N. Kurapati
-# See the LICENSE file for details.
+# Copyright protects this work.
+# See LICENSE file for details.
 #++
 
 module Rumai

data/lib/rumai/ixp/transport.rb

@@ -1,7 +1,7 @@
 # Transport layer for 9P2000 protocol.
 #--
-# Copyright 2007 Suraj N. Kurapati
-# See the LICENSE file for details.
+# Copyright protects this work.
+# See LICENSE file for details.
 #++
 
 require 'rumai/ixp/message'

data/lib/rumai/wm.rb

@@ -1,7 +1,7 @@
 # Abstractions for the window manager.
 #--
-# Copyright 2006 Suraj N. Kurapati
-# See the LICENSE file for details.
+# Copyright protects this work.
+# See LICENSE file for details.
 #++
 
 require 'rumai/fs'
@@ -144,7 +144,7 @@ module Rumai
                 distance = (src - dst).abs
                 direction = src < dst ? :down : :up
 
-                distance.times { v.move_focus direction }
+                distance.times { v.select direction }
 
                 break
               end
@@ -248,6 +248,46 @@ module Rumai
           end
         end
 
+        ##
+        # Checks if this client is in the floating area of the given view.
+        #
+        def float? view = View.curr
+          area(view).floating?
+        end
+
+        ##
+        # Puts this client into the floating area of the given view.
+        #
+        def float view = View.curr
+          send :toggle, view unless float? view
+        end
+
+        ##
+        # Puts this client into the managed area of the given view.
+        #
+        def unfloat view = View.curr
+          send :toggle, view if float? view
+        end
+
+        ##
+        # Toggles the floating status of this client in the given view.
+        #
+        def float! view = View.curr
+          send :toggle, view
+        end
+
+        ##
+        # Checks if this client is in the managed area of the given view.
+        def manage? view = View.curr
+          not float? view
+        end
+
+        alias manage unfloat
+
+        alias unmanage float
+
+        alias manage! float!
+
       # WM hierarchy
 
         ##
@@ -278,9 +318,44 @@ module Rumai
         ##
         # Modifies the tags associated with this client.
         #
+        # If a tag name is '~', this client is placed
+        # into the floating layer of the current view.
+        #
+        # If a tag name begins with '~', then this
+        # client is placed into the floating layer
+        # of the view corresponding to that tag.
+        #
+        # If a tag name is '!', this client is placed
+        # into the managed layer of the current view.
+        #
+        # If a tag name begins with '!', then this
+        # client is placed into the managed layer
+        # of the view corresponding to that tag.
+        #
         def tags= *tags
-          arr = tags.flatten.compact.uniq
-          self[:tags].write arr.join(TAG_DELIMITER)
+          float = []
+          manage = []
+          inherit = []
+
+          tags.join(TAG_DELIMITER).split(TAG_DELIMITER).each do |tag|
+            case tag
+            when '~'  then float   << Rumai.curr_tag
+            when /^~/ then float   << $'
+            when '!'  then manage  << Rumai.curr_tag
+            when /^!/ then manage  << $'
+            else           inherit << tag
+            end
+          end
+
+          self[:tags].write((float + manage + inherit).uniq.join(TAG_DELIMITER))
+
+          float.each do |tag|
+            self.float View.new(tag)
+          end
+
+          manage.each do |tag|
+            self.manage View.new(tag)
+          end
         end
 
         ##