rumai 3.2.0 → 3.2.1

data/lib/rumai/wm.rb

@@ -1,13 +1,9 @@
 # Abstractions for the window manager.
-#--
-# Copyright protects this work.
-# See LICENSE file for details.
-#++
 
 require 'rumai/fs'
 require 'enumerator'
 
-class Object #:nodoc:
+class Object # @private
   # prevent these deprecated properties
   # from clashing with our usage below
   undef id   if respond_to? :id
@@ -21,12 +17,12 @@ module Rumai
   CLIENT_GROUPING_TAG = '@'.freeze
   CLIENT_STICKY_TAG   = '/./'.freeze
 
-  #-----------------------------------------------------------------------------
+  #---------------------------------------------------------------------------
   # abstraction of WM components
-  #-----------------------------------------------------------------------------
+  #---------------------------------------------------------------------------
 
     ##
-    # NOTE: Inheritors must override the 'chain' method.
+    # @note Inheritors must override the {Chain#chain} method.
     #
     module Chain
       ##
@@ -64,10 +60,10 @@ module Rumai
     ##
     # The basic building block of the WM hierarchy.
     #
-    # NOTE: Inheritors must define a 'curr' class method.
-    # NOTE: Inheritors must override the 'focus' method.
+    # @note Inheritors must define a {curr} class method.
+    # @note Inheritors must override the {focus} method.
     #
-    module WidgetImpl #:nodoc:
+    module WidgetImpl
       attr_reader :id
 
       def == other
@@ -87,7 +83,7 @@ module Rumai
     ##
     # A widget that has a corresponding representation in the IXP file system.
     #
-    class WidgetNode < Node #:nodoc:
+    class WidgetNode < Node
       include WidgetImpl
 
       def initialize id, path_prefix
@@ -126,9 +122,9 @@ module Rumai
           View.curr.clients
         end
 
-      #-------------------------------------------------------------------------
+      #-----------------------------------------------------------------------
       # WM operations
-      #-------------------------------------------------------------------------
+      #-----------------------------------------------------------------------
 
         ##
         # Focuses this client within the given view.
@@ -188,7 +184,8 @@ module Rumai
         end
 
         ##
-        # Maximizes this client to occupy the entire screen on the current view.
+        # Maximizes this client to occupy the
+        # entire screen on the current view.
         #
         def fullscreen
           ctl.write 'Fullscreen on'
@@ -291,9 +288,9 @@ module Rumai
 
         alias manage! float!
 
-      #-------------------------------------------------------------------------
+      #-----------------------------------------------------------------------
       # WM hierarchy
-      #-------------------------------------------------------------------------
+      #-----------------------------------------------------------------------
 
         ##
         # Returns the area that contains this client within the given view.
@@ -309,9 +306,9 @@ module Rumai
           tags.map! {|t| View.new t }
         end
 
-      #-------------------------------------------------------------------------
+      #-----------------------------------------------------------------------
       # tag manipulations
-      #-------------------------------------------------------------------------
+      #-----------------------------------------------------------------------
 
         TAG_DELIMITER = '+'.freeze
 
@@ -395,9 +392,9 @@ module Rumai
           end
         end
 
-      #-------------------------------------------------------------------------
+      #-----------------------------------------------------------------------
       # multiple client grouping
-      #-------------------------------------------------------------------------
+      #-----------------------------------------------------------------------
 
         ##
         # Checks if this client is included in the current grouping.
@@ -449,7 +446,7 @@ module Rumai
     end
 
     ##
-    # NOTE: Inheritors should override the 'client_ids' method.
+    # @note Inheritors should override the {ClientContainer#client_ids} method.
     #
     module ClientContainer
       ##
@@ -491,7 +488,8 @@ module Rumai
       attr_reader :view
 
       ##
-      # [view] the view object which contains this area
+      # @param [Rumai::View] view
+      #   the view object which contains this area
       #
       def initialize area_id, view = View.curr
         @id = Integer(area_id) rescue area_id
@@ -576,9 +574,9 @@ module Rumai
         @view.ctl.write "colmode #{@id} #{mode}"
       end
 
-      #-------------------------------------------------------------------------
+      #-----------------------------------------------------------------------
       # WM operations
-      #-------------------------------------------------------------------------
+      #-----------------------------------------------------------------------
 
         ##
         # Puts focus on this area.
@@ -587,9 +585,9 @@ module Rumai
           @view.ctl.write "select #{@id}"
         end
 
-      #-------------------------------------------------------------------------
+      #-----------------------------------------------------------------------
       # array abstraction: area is an array of clients
-      #-------------------------------------------------------------------------
+      #-----------------------------------------------------------------------
 
         ##
         # Returns the number of clients in this area.
@@ -761,9 +759,9 @@ module Rumai
         super view_id, '/tag'
       end
 
-      #-------------------------------------------------------------------------
+      #-----------------------------------------------------------------------
       # WM operations
-      #-------------------------------------------------------------------------
+      #-----------------------------------------------------------------------
 
         ##
         # Returns the manifest of all areas and clients in this view.
@@ -779,9 +777,9 @@ module Rumai
           ctl.write "select #{direction}"
         end
 
-      #-------------------------------------------------------------------------
+      #-----------------------------------------------------------------------
       # WM hierarchy
-      #-------------------------------------------------------------------------
+      #-----------------------------------------------------------------------
 
         ##
         # Returns the area which contains the given client in this view.
@@ -852,9 +850,9 @@ module Rumai
 
         alias each_managed_area each_column
 
-      #-------------------------------------------------------------------------
+      #-----------------------------------------------------------------------
       # visual arrangement of clients
-      #-------------------------------------------------------------------------
+      #-----------------------------------------------------------------------
 
         ##
         # Arranges the clients in this view, while maintaining
@@ -1011,9 +1009,9 @@ module Rumai
       end
     end
 
-  #-----------------------------------------------------------------------------
+  #---------------------------------------------------------------------------
   # access to global WM state
-  #-----------------------------------------------------------------------------
+  #---------------------------------------------------------------------------
 
     ##
     # Returns the root of IXP file system hierarchy.
@@ -1061,9 +1059,9 @@ module Rumai
       list
     end
 
-  #-----------------------------------------------------------------------------
+  #---------------------------------------------------------------------------
   # shortcuts for interactive WM manipulation (via IRB)
-  #-----------------------------------------------------------------------------
+  #---------------------------------------------------------------------------
 
     def curr_client ; Client.curr       ; end
     def next_client ; curr_client.next  ; end

data/test/rumai/inochi_test.rb

@@ -0,0 +1,17 @@
+require 'rumai/inochi'
+
+unless defined? Rumai::INOCHI
+  fail "Rumai module must be established by Inochi"
+end
+
+Rumai::INOCHI.each do |param, value|
+  const = param.to_s.upcase
+
+  unless Rumai.const_defined? const
+    fail "Rumai::#{const} must be established by Inochi"
+  end
+
+  unless Rumai.const_get(const) == value
+    fail "Rumai::#{const} is not what Inochi established"
+  end
+end

data/test/rumai/ixp/message_test.rb

@@ -0,0 +1,245 @@
+require 'rumai/fs'
+require 'pp' if $DEBUG
+
+D 'IXP' do
+  extend Rumai::IXP
+
+  D .<< do
+    # connect to the wmii IXP server
+    @conn = UNIXSocket.new(Rumai::IXP_SOCK_ADDR)
+
+    # at_exit do
+    #   puts "just making sure there is no more data in the pipe"
+    #   while c = @conn.getc
+    #     puts c
+    #   end
+    # end
+
+    D 'establish a new session' do
+      request, response = talk(Tversion,
+        :tag     => Fcall::NOTAG,
+        :msize   => Tversion::MSIZE,
+        :version => Tversion::VERSION
+      )
+      T { response.type == Rversion.type }
+      T { response.version == request.version }
+    end
+  end
+
+  D 'can read a directory' do
+    D 'attach to FS root' do
+      request, response = talk(Tattach,
+        :tag   => 0,
+        :fid   => 0,
+        :afid  => Fcall::NOFID,
+        :uname => ENV['USER'],
+        :aname => ''
+      )
+      T { response.type == Rattach.type }
+    end
+
+    D 'stat FS root' do
+      request, response = talk(Tstat,
+        :tag => 0,
+        :fid => 0
+      )
+      T { response.type == Rstat.type }
+    end
+
+    D 'open the FS root for reading' do
+      request, response = talk(Topen,
+        :tag  => 0,
+        :fid  => 0,
+        :mode => Topen::OREAD
+      )
+      T { response.type == Ropen.type }
+    end
+
+    D 'fetch a Stat for every file in FS root' do
+      request, response = talk(Tread,
+        :tag    => 0,
+        :fid    => 0,
+        :offset => 0,
+        :count  => Tversion::MSIZE
+      )
+      T { response.type == Rread.type }
+
+      if $DEBUG
+        s = StringIO.new(response.data, 'r')
+        a = []
+
+        until s.eof?
+          t = Stat.from_9p(s)
+          a << t
+        end
+
+        pp a
+      end
+    end
+
+    D 'close the fid for FS root' do
+      request, response = talk(Tclunk,
+        :tag    => 0,
+        :fid    => 0
+      )
+      T { response.type == Rclunk.type }
+    end
+
+    D 'closed fid should not be readable' do
+      request, response = talk(Tread,
+        :tag    => 0,
+        :fid    => 0,
+        :offset => 0,
+        :count  => Tversion::MSIZE
+      )
+      T { response.type == Rerror.type }
+    end
+  end
+
+  D 'can read & write a file' do
+    D 'attach to /' do
+      request, response = talk(Tattach,
+        :tag   => 0,
+        :fid   => 0,
+        :afid  => Fcall::NOFID,
+        :uname => ENV['USER'],
+        :aname => ''
+      )
+      T { response.type == Rattach.type }
+    end
+
+    file = %W[rbar temp#{$$}]
+    root = file[0..-2]
+    leaf = file.last
+
+    D "walk to #{root.inspect}" do
+      request, response = talk(Twalk,
+        :tag    => 0,
+        :fid    => 0,
+        :newfid => 1,
+        :wname => root
+      )
+      T { response.type == Rwalk.type }
+    end
+
+    D "create #{leaf.inspect}" do
+      request, response = talk(Tcreate,
+        :tag  => 0,
+        :fid  => 1,
+        :name => leaf,
+        :perm => 0644,
+        :mode => Topen::ORDWR
+      )
+      T { response.type == Rcreate.type }
+    end
+
+    D "close the fid for #{root.inspect}" do
+      request, response = talk(Tclunk,
+        :tag => 0,
+        :fid => 1
+      )
+      T { response.type == Rclunk.type }
+    end
+
+    D "walk to #{file.inspect} from /" do
+      request, response = talk(Twalk,
+        :tag    => 0,
+        :fid    => 0,
+        :newfid => 1,
+        :wname => file
+      )
+      T { response.type == Rwalk.type }
+    end
+
+    D 'close the fid for /' do
+      request, response = talk(Tclunk,
+        :tag => 0,
+        :fid => 0
+      )
+      T { response.type == Rclunk.type }
+    end
+
+    D "open #{file.inspect} for writing" do
+      request, response = talk(Topen,
+        :tag  => 0,
+        :fid  => 1,
+        :mode => Topen::ORDWR
+      )
+      T { response.type == Ropen.type }
+    end
+
+    D "write to #{file.inspect}" do
+      write_request, write_response = talk(Twrite,
+        :tag    => 0,
+        :fid    => 1,
+        :offset => 0,
+        :data   => "#a1a2a3 #b1b2b3 #c1c2c3 hello world!!!"
+      )
+      T { write_response.type == Rwrite.type }
+      T { write_response.count == write_request.data.length }
+
+      D "verify the write" do
+        read_request, read_response = talk(Tread,
+          :tag    => 0,
+          :fid    => 1,
+          :offset => 0,
+          :count  => write_response.count
+        )
+        T { read_response.type == Rread.type }
+        T { read_response.data == write_request.data }
+      end
+    end
+
+    D "remove #{file.inspect}" do
+      request, response = talk(Tremove,
+        :tag => 0,
+        :fid => 1
+      )
+      T { response.type == Rremove.type }
+    end
+
+    D "fid for #{file.inspect} should have been closed by Tremove" do
+      request, response = talk(Tclunk,
+        :tag => 0,
+        :fid => 1
+      )
+      T { response.type == Rerror.type }
+    end
+  end
+
+  ##
+  # Transmits the given request and returns the received response.
+  #
+  def talk request_type, request_options
+    request = request_type.new(request_options)
+
+    # send the request
+    if $DEBUG
+      puts
+      pp request
+      pp request.to_9p
+    end
+
+    @conn << request.to_9p
+
+    # receive the response
+    response = Fcall.from_9p(@conn)
+
+    if $DEBUG
+      puts
+      pp response
+      pp response.to_9p
+    end
+
+    if response.type == Rerror.type
+      T { response.kind_of? Rerror }
+    else
+      T { response.type == request.type + 1 }
+    end
+
+    T { response.tag == request.tag }
+
+    # return the conversation
+    [request, response]
+  end
+end