i3-ipc 0.1.3 → 0.1.4

data/README.markdown

@@ -58,11 +58,11 @@ There are 3 arguments passed to the block:
 To send data to the socket, you need to use `em.send_data`.
 * `type` is the received message type.
 This could be one of
-  * MESSAGE_REPLY_COMMAND
-  * MESSAGE_REPLY_GET_WORKSPACES
-  * MESSAGE_REPLY_SUBSCRIBE
-  * MESSAGE_REPLY_GET_OUTPUTS
-  * EVENT_WORKSPACE
+  * MESSAGE\_REPLY\_COMMAND
+  * MESSAGE\_REPLY\_GET\_WORKSPACES
+  * MESSAGE\_REPLY\_SUBSCRIBE
+  * MESSAGE\_REPLY\_GET\_OUTPUTS
+  * EVENT\_WORKSPACE
 * `data` is the received data, already parsed.
 
 For example you can use the following code to get the actual focused screen:

data/Rakefile

@@ -6,7 +6,7 @@ begin
   task :gem => :package
 
   desc "Push a new version to Gemcutter and publish docs."
-  task :publish => :gemcutter do
+  task :publish => [:test, :gemcutter] do
     require File.dirname(__FILE__) + '/lib/i3-ipc/version'
 
     sh "git tag v#{I3::Version}"

data/lib/i3-ipc.rb

@@ -8,7 +8,7 @@ require 'i3-ipc/version'
 module I3
   class IPC
     MAGIC_STRING = "i3-ipc"
-    SOCKET_PATH = "/tmp/i3-ipc.sock"
+    SOCKET_PATH = File.expand_path("~/.i3/ipc.sock")
 
     MESSAGE_TYPE_COMMAND = 0
     MESSAGE_TYPE_GET_WORKSPACES = 1

data/lib/i3-ipc/runner.rb

@@ -4,15 +4,16 @@ require 'pp'
 module I3
   module Runner
     extend self
+    OUTPUT = $stdout
 
     def format_output(object, output)
       if output == :pretty_print
-        pp object
+        PP.pp(object, OUTPUT)
       elsif output == :json
         require 'json'
-        puts object.to_json
+        OUTPUT.puts object.to_json
       else
-        p object
+        OUTPUT.puts object.inspect
       end
     end
 
@@ -29,7 +30,7 @@ module I3
     end
 
     def execute(*args)
-      socket_file = '/tmp/i3-ipc.sock'
+      socket_file = File.expand_path('~/.i3/ipc.sock')
       type = 0
       quiet = false
       output = :default
@@ -37,9 +38,9 @@ module I3
       opts = OptionParser.new do |opts|
         opts.banner = "Usage: i3-ipc [options] [message]"
 
-        s_desc = 'Set socket file, defaults to /tmp/i3-ipc.sock'
-        opts.on('-s', '--socket', s_desc) do |s|
-          socket_file = s
+        s_desc = 'Set socket file, defaults to ~/.i3/ipc.sock'
+        opts.on('-s SOCKET', '--socket SOCKET', s_desc) do |s|
+          socket_file = File.expand_path(s)
         end
 
         t_desc = 'Set type, 0 = command, 1 = workspace list, 2 = subscribe to workspace event, 3 = output list, default: 0'
@@ -64,7 +65,7 @@ module I3
         end
 
         opts.on('-h', '--help', 'Display this screen') do
-          puts opts
+          OUTPUT.puts opts
           exit
         end
       end
@@ -80,8 +81,7 @@ module I3
         end
 
         payload = args.shift
-
-        puts s.command(payload) unless quiet
+        OUTPUT.puts s.command(payload).inspect unless quiet
       when I3::IPC::MESSAGE_TYPE_GET_WORKSPACES
         format_output s.get_workspaces, output
       when I3::IPC::MESSAGE_REPLY_SUBSCRIBE

data/lib/i3-ipc/version.rb

@@ -1,3 +1,3 @@
 module I3
-  Version = '0.1.3'
+  Version = '0.1.4'
 end

data/man/i3-ipc.1

@@ -1,7 +1,7 @@
-.\" generated with Ronn/v0.4.1
+.\" generated with Ronn/v0.5
 .\" http://github.com/rtomayko/ronn/
 .
-.TH "I3\-IPC" "1" "March 2010" "badboy" "i3-ipc Manual"
+.TH "I3\-IPC" "1" "April 2010" "badboy" "i3-ipc Manual"
 .
 .SH "NAME"
 \fBi3\-ipc\fR \-\- inter\-process communication with i3
@@ -25,7 +25,16 @@ Currently implemented message types of i3 are the following:
 .TP
 \fB1 (GET_WORKSPACES)\fR
   Gets the current workspaces.
-  The reply will be a JSON\-encoded list of workspaces (see the reply section).
+  The reply will be a JSON\-encoded list of workspaces.
+.
+.TP
+\fB2 (SUBSCRIBE)\fR
+  Subscribes your connection to the \fBworkspace\fR event.
+.
+.TP
+\fB3 (GET_OUTPUTS)\fR
+  Gets the current outputs.
+  The reply will be a JSON\-encoded list of outputs.
 .
 .SH "OPTIONS"
 \fBi3\-ipc\fR's default mode of operation is to send the command (type 0) specified on the command line.
@@ -35,11 +44,12 @@ These options can be used to change this behavior:
 .
 .TP
 \fB\-s\fR, \fB\-\-socket\fR
-Set the socket file, defaults to /tmp/i3\-ipc.sock
+Set the socket file, defaults to ~/.i3/ipc.sock
 .
 .TP
 \fB\-t\fR, \fB\-\-type\fR
-Set the type. Passing a type of 0 is the default and will send the specified command, type 1 gets the current workspace list.
+Set the type. Passing a type of 0 is the default and will send the specified command, type 1 gets the current workspace list,
+type 2 subscribes to the workspace stream, type 3 gets the current output list.
 .
 .TP
 \fB\-p\fR, \fB\-\-pretty\-print\fR
@@ -71,9 +81,10 @@ Display this man page.
 .SH "EXAMPLES"
 .
 .nf
+
 $ i3\-ipc \-t 1
-$ i3\-ipc \-t 1 \-p
-$ i3\-ipc \-t 1 \-j
+$ i3\-ipc \-t 2 \-p
+$ i3\-ipc \-t 3 \-j
 $ i3\-ipc "exec xterm"
 .
 .fi

data/man/i3-ipc.1.html

@@ -2,7 +2,7 @@
 <html>
 <head>
   <meta http-equiv='content-type' value='text/html;charset=utf8'>
-  <meta name='generator' value='Ronn/v0.4.1'>
+  <meta name='generator' value='Ronn/v0.5'>
   <title>i3-ipc(1) -- inter-process communication with i3</title>
   <style type='text/css'>
     body {margin:0}
@@ -81,7 +81,10 @@
   The command will be executed directly after receiving it.
   The reply will be always {"succes":true} for now.</dd>
 <dt><code>1 (GET_WORKSPACES)</code></dt><dd>  Gets the current workspaces.
-  The reply will be a JSON-encoded list of workspaces (see the reply section).</dd>
+  The reply will be a JSON-encoded list of workspaces.</dd>
+<dt><code>2 (SUBSCRIBE)</code></dt><dd>  Subscribes your connection to the <code>workspace</code> event.</dd>
+<dt><code>3 (GET_OUTPUTS)</code></dt><dd>  Gets the current outputs.
+  The reply will be a JSON-encoded list of outputs.</dd>
 </dl>
 
 
@@ -92,8 +95,9 @@
 <p>These options can be used to change this behavior:</p>
 
 <dl>
-<dt><code>-s</code>, <code>--socket</code></dt><dd><p>Set the socket file, defaults to /tmp/i3-ipc.sock</p></dd>
-<dt><code>-t</code>, <code>--type</code></dt><dd><p>Set the type. Passing a type of 0 is the default and will send the specified command, type 1 gets the current workspace list.</p></dd>
+<dt><code>-s</code>, <code>--socket</code></dt><dd><p>Set the socket file, defaults to ~/.i3/ipc.sock</p></dd>
+<dt><code>-t</code>, <code>--type</code></dt><dd><p>Set the type. Passing a type of 0 is the default and will send the specified command, type 1 gets the current workspace list,
+type 2 subscribes to the workspace stream, type 3 gets the current output list.</p></dd>
 <dt><code>-p</code>, <code>--pretty-print</code></dt><dd><p>This will pretty print the received reply. Useful for the workspace list.</p></dd>
 <dt><code>-j</code>, <code>--json</code></dt><dd><p>This will print the received reply as raw json-encoded data. Useful to pass to another script.</p></dd>
 <dt><code>-q</code>, <code>--quiet</code></dt><dd><p>Turn off the output. Useful for command mode.</p></dd>
@@ -112,8 +116,8 @@
 <h2>EXAMPLES</h2>
 
 <pre><code>$ i3-ipc -t 1
-$ i3-ipc -t 1 -p
-$ i3-ipc -t 1 -j
+$ i3-ipc -t 2 -p
+$ i3-ipc -t 3 -j
 $ i3-ipc "exec xterm"
 </code></pre>
 
@@ -132,7 +136,7 @@ $ i3-ipc "exec xterm"
 
 <ol class='foot man'>
   <li class='tl'>badboy</li>
-  <li class='tc'>March 2010</li>
+  <li class='tc'>April 2010</li>
   <li class='tr'>i3-ipc(1)</li>
 </ol>
 

data/man/i3-ipc.1.ronn

@@ -14,12 +14,18 @@ Currently implemented message types of i3 are the following:
 
   * `0 (COMMAND)`:
       The payload of the message is a command for i3
-      (like the commands you can bind to keys in the configuration file) 
+      (like the commands you can bind to keys in the configuration file)
       The command will be executed directly after receiving it.
       The reply will be always {"succes":true} for now.
   * `1 (GET_WORKSPACES)`:
-      Gets the current workspaces. 
-      The reply will be a JSON-encoded list of workspaces (see the reply section).
+      Gets the current workspaces.
+      The reply will be a JSON-encoded list of workspaces.
+  * `2 (SUBSCRIBE)`:
+      Subscribes your connection to the `workspace` event.
+  * `3 (GET_OUTPUTS)`:
+      Gets the current outputs.
+      The reply will be a JSON-encoded list of outputs.
+
 
 ## OPTIONS
 
@@ -28,10 +34,11 @@ Currently implemented message types of i3 are the following:
 These options can be used to change this behavior:
 
   * `-s`, `--socket`:
-    Set the socket file, defaults to /tmp/i3-ipc.sock
+    Set the socket file, defaults to ~/.i3/ipc.sock
 
   * `-t`, `--type`:
-    Set the type. Passing a type of 0 is the default and will send the specified command, type 1 gets the current workspace list.
+    Set the type. Passing a type of 0 is the default and will send the specified command, type 1 gets the current workspace list,
+    type 2 subscribes to the workspace stream, type 3 gets the current output list.
 
   * `-p`, `--pretty-print`:
     This will pretty print the received reply. Useful for the workspace list.
@@ -56,8 +63,8 @@ You may additionally ask for help:
 ## EXAMPLES
 
     $ i3-ipc -t 1
-    $ i3-ipc -t 1 -p
-    $ i3-ipc -t 1 -j
+    $ i3-ipc -t 2 -p
+    $ i3-ipc -t 3 -j
     $ i3-ipc "exec xterm"
 
 ## BUGS

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Jan-Erik Rediger
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-08 00:00:00 +02:00
+date: 2010-04-16 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,7 +43,7 @@ dependencies:
         - 10
         - 3
         version: 2.10.3
-  type: :runtime
+  type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: mocha
@@ -57,7 +57,7 @@ dependencies:
         - 9
         - 8
         version: 0.9.8
-  type: :runtime
+  type: :development
   version_requirements: *id003
 description: "  uses the ipc socket of i3 to send commands or get information directly from the window manager. Useful for scripting the window manager.'\n"
 email: badboy@archlinux.us